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.
Usage
WP_CLI\Utils\format_items( $format, $items, $fields )
$items (array) An array of items to output.
$fields (array|string) Named fields for each item of data. Can be array or comma-separated list.
Notes
Given a collection of items with a consistent data structure:
$items = array(
array(
'key' => 'foo',
'value' => 'bar',
)
);
Render $items
as an ASCII table:
WP_CLI\Utils\format_items( 'table', $items, array( 'key', 'value' ) );
# +-----+-------+
# | key | value |
# +-----+-------+
# | foo | bar |
# +-----+-------+
Or render $items
as YAML:
WP_CLI\Utils\format_items( 'yaml', $items, array( 'key', 'value' ) );
# ---
# -
# key: foo
# value: bar
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 release. To suggest improvements, please submit a pull request.
Related
- WP_CLI\Utils\make_progress_bar() – Create a progress bar to display percent completion of a given operation.
- WP_CLI::colorize() – Colorize a string for output.
- 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.