WP_CLI::colorize() Edit

Colorize a string for output.


Usage Usage

WP_CLI::colorize( $string )
$string (string) String to colorize for output, with color tokens.
@return (string) string.

Top ↑

Notes Notes

Yes, you can change the color of command line text too. For instance,
here’s how WP_CLI::success() colorizes “Success: ”

WP_CLI::colorize( "%GSuccess:%n " )

Uses \cli\Colors::colorize() to transform color tokens to display
settings. Choose from the following tokens (and note ‘reset’):

  • %y => [‘color’ => ‘yellow’],
  • %g => [‘color’ => ‘green’],
  • %b => [‘color’ => ‘blue’],
  • %r => [‘color’ => ‘red’],
  • %p => [‘color’ => ‘magenta’],
  • %m => [‘color’ => ‘magenta’],
  • %c => [‘color’ => ‘cyan’],
  • %w => [‘color’ => ‘grey’],
  • %k => [‘color’ => ‘black’],
  • %n => [‘color’ => ‘reset’],
  • %Y => [‘color’ => ‘yellow’, ‘style’ => ‘bright’],
  • %G => [‘color’ => ‘green’, ‘style’ => ‘bright’],
  • %B => [‘color’ => ‘blue’, ‘style’ => ‘bright’],
  • %R => [‘color’ => ‘red’, ‘style’ => ‘bright’],
  • %P => [‘color’ => ‘magenta’, ‘style’ => ‘bright’],
  • %M => [‘color’ => ‘magenta’, ‘style’ => ‘bright’],
  • %C => [‘color’ => ‘cyan’, ‘style’ => ‘bright’],
  • %W => [‘color’ => ‘grey’, ‘style’ => ‘bright’],
  • %K => [‘color’ => ‘black’, ‘style’ => ‘bright’],
  • %N => [‘color’ => ‘reset’, ‘style’ => ‘bright’],
  • %3 => [‘background’ => ‘yellow’],
  • %2 => [‘background’ => ‘green’],
  • %4 => [‘background’ => ‘blue’],
  • %1 => [‘background’ => ‘red’],
  • %5 => [‘background’ => ‘magenta’],
  • %6 => [‘background’ => ‘cyan’],
  • %7 => [‘background’ => ‘grey’],
  • %0 => [‘background’ => ‘black’],
  • %F => [‘style’ => ‘blink’],
  • %U => [‘style’ => ‘underline’],
  • %8 => [‘style’ => ‘inverse’],
  • %9 => [‘style’ => ‘bright’],
  • %_ => [‘style’ => ‘bright’]

Internal APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. documentation is generated from the WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ codebase on every releaseRelease A release is the distribution of the final version of an application. A software release may be either public or private and generally constitutes the initial or new generation of a new or upgraded application. A release is preceded by the distribution of alpha and then beta versions of the software.. To suggest improvements, please submit a pull request.


Top ↑

  • WP_CLI\Utils\make_progress_bar() – Create a progress bar to display percent completion of a given operation.
  • WP_CLI\Utils\format_items() – Render a collection of items as an ASCII table, JSONJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML., CSV, YAML, list of ids, or count.
  • WP_CLI::line() – Display informational message without prefix, and ignore `–quiet`.
  • WP_CLI::log() – Display informational message without prefix.
  • WP_CLI::success() – Display success message prefixed with "Success: ".
  • WP_CLI::debug() – Display debug message prefixed with "Debug: " when `–debug` is used.
  • WP_CLI::warning() – Display warning message prefixed with "Warning: ".
  • WP_CLI::error() – Display error message prefixed with "Error: " and exit script.
  • WP_CLI::halt() – Halt script execution with a specific return code.
  • WP_CLI::error_multi_line() – Display a multi-line error message in a red box. Doesn’t exit script.

Last updated: