WP_CLI::colorize()
Colorize a string for output.
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']
Method of the class: WP_CLI{}
No Hooks.
Return
String
. Colorized string.
Usage
$result = WP_CLI::colorize( $string );
- $string(string) (required)
- String to colorize for output, with color tokens.
WP_CLI::colorize() WP CLI::colorize code WP-CLI 2.8.0-alpha
public static function colorize( $string ) { return Colors::colorize( $string, self::get_runner()->in_color() ); }