/** * List registered sidebars. * * ## OPTIONS * * [--fields=<fields>] * : Limit the output to specific object fields. * * [--format=<format>] * : Accepted values: table, csv, json, count, yaml. Default: table * * ## AVAILABLE FIELDS * * These fields will be displayed by default for each sidebar: * * * name * * id * * description * * These fields are optionally available: * * * class * * before_widget * * after_widget * * before_title * * after_title * * ## EXAMPLES * * wp sidebar list --fields=name,id --format=csv * * @subcommand list */ public function list_($args, $assoc_args) { global $wp_registered_sidebars; \WP_CLI\Utils\wp_register_unused_sidebar(); $formatter = new \WP_CLI\Formatter($assoc_args, $this->fields); $formatter->display_items($wp_registered_sidebars); }
/** * List registered sidebars. * * ## OPTIONS * * [--fields=<fields>] * : Limit the output to specific object fields. * * [--format=<format>] * : Render output in a particular format. * --- * default: table * options: * - table * - csv * - json * - ids * - count * - yaml * --- * * ## AVAILABLE FIELDS * * These fields will be displayed by default for each sidebar: * * * name * * id * * description * * These fields are optionally available: * * * class * * before_widget * * after_widget * * before_title * * after_title * * ## EXAMPLES * * $ wp sidebar list --fields=name,id --format=csv * name,id * "Widget Area",sidebar-1 * "Inactive Widgets",wp_inactive_widgets * * @subcommand list */ public function list_($args, $assoc_args) { global $wp_registered_sidebars; \WP_CLI\Utils\wp_register_unused_sidebar(); if (!empty($assoc_args['format']) && 'ids' === $assoc_args['format']) { $sidebars = wp_list_pluck($wp_registered_sidebars, 'id'); } else { $sidebars = $wp_registered_sidebars; } $formatter = new \WP_CLI\Formatter($assoc_args, $this->fields); $formatter->display_items($sidebars); }
/** * Check whether a sidebar is a valid sidebar * * @param string $sidebar_id */ private function validate_sidebar($sidebar_id) { global $wp_registered_sidebars; \WP_CLI\Utils\wp_register_unused_sidebar(); if (!array_key_exists($sidebar_id, $wp_registered_sidebars)) { WP_CLI::error("Invalid sidebar."); } }