A command line interface for WordPress

Docs » Internal API » Output


Create a progress bar to display percent completion of a given operation.


WP_CLI\Utils\make_progress_bar( $message, $count )
$message (string) Text to display before the progress bar.
$count (integer) Total number of ticks to be performed.
@return (cli\progress\Bar|WP_CLI\NoOp)


Progress bar is written to STDOUT, and disabled when command is piped. Progress advances with $progress->tick(), and completes with $progress->finish(). Process bar also indicates elapsed time and expected total time.

# `wp user generate` ticks progress bar each time a new user is created.
# $ wp user generate --count=500
# Generating users  22 % [=======>                             ] 0:05 / 0:23

$progress = \WP_CLI\Utils\make_progress_bar( 'Generating users', $count );
for ( $i = 0; $i < $count; $i++ ) {
    // uses wp_insert_user() to insert the user

Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.