mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-04-29 20:05:17 +08:00
264cb131bf
- Organize files in folders according to the desired structure - Use directory iterator to loop through all files and folders (makes generation more robust)
87 lines
3.2 KiB
Markdown
87 lines
3.2 KiB
Markdown
# WP_CLI::debug()
|
|
|
|
Display debug message prefixed with "Debug: " when `--debug` is used.
|
|
|
|
***
|
|
|
|
## Usage
|
|
|
|
WP_CLI::debug( $message, $group = false )
|
|
|
|
<div>
|
|
<strong>$message</strong> (string|WP_Error|Exception|Throwable) Message to write to STDERR.<br />
|
|
<strong>$group</strong> (string|bool) Organize debug message to a specific group.<br />
|
|
<strong>@return</strong> (void) <br />
|
|
</div>
|
|
|
|
|
|
***
|
|
|
|
## Notes
|
|
|
|
Debug message is written to STDERR, and includes script execution time.
|
|
|
|
Helpful for optionally showing greater detail when needed. Used throughout
|
|
WP-CLI bootstrap process for easier debugging and profiling.
|
|
|
|
```
|
|
# Called in `WP_CLI\Runner::set_wp_root()`.
|
|
private static function set_wp_root( $path ) {
|
|
define( 'ABSPATH', Utils\trailingslashit( $path ) );
|
|
WP_CLI::debug( 'ABSPATH defined: ' . ABSPATH );
|
|
$_SERVER['DOCUMENT_ROOT'] = realpath( $path );
|
|
}
|
|
|
|
# Debug details only appear when `--debug` is used.
|
|
# $ wp --debug
|
|
# [...]
|
|
# Debug: ABSPATH defined: /srv/www/wordpress-develop.dev/src/ (0.225s)
|
|
```
|
|
Use `false` to not group the message.
|
|
|
|
|
|
*Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.*
|
|
|
|
|
|
***
|
|
|
|
## Related
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-utils-format-items/">WP_CLI\Utils\format_items()</a></strong> - Render a collection of items as an ASCII table, JSON, CSV, YAML, list of ids, or count.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-utils-make-progress-bar/">WP_CLI\Utils\make_progress_bar()</a></strong> - Create a progress bar to display percent completion of a given operation.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-colorize/">WP_CLI::colorize()</a></strong> - Colorize a string for output.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-line/">WP_CLI::line()</a></strong> - Display informational message without prefix, and ignore `--quiet`.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-log/">WP_CLI::log()</a></strong> - Display informational message without prefix.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-success/">WP_CLI::success()</a></strong> - Display success message prefixed with "Success: ".</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-warning/">WP_CLI::warning()</a></strong> - Display warning message prefixed with "Warning: ".</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-error/">WP_CLI::error()</a></strong> - Display error message prefixed with "Error: " and exit script.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-halt/">WP_CLI::halt()</a></strong> - Halt script execution with a specific return code.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-error-multi-line/">WP_CLI::error_multi_line()</a></strong> - Display a multi-line error message in a red box. Doesn't exit script.</li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
