WP-CLI 命令行手册

title: "WP_CLI\Utils\make_progress_bar()" post_status: publish comment_status: open taxonomy: category: - wp-cli-handbook post_tag: - Internal Api - References - Repos

WP_CLI\Utils\make_progress_bar()

创建一个进度条，用于显示给定操作的完成百分比。

用法

WP_CLI\Utils\make_progress_bar( $message, $count, $interval = 100 )
$message (string) 进度条前显示的文本。
$count (integer) 要执行的总刻度数。
$interval (int) 可选。更新间隔（毫秒）。默认值为 100。
@return (\cli\progress\Bar|\WP_CLI\NoOp)

Notes

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
    $progress->tick();
}
$progress->finish();

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

相关