mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-05-07 06:28:59 +08:00
264cb131bf
- Organize files in folders according to the desired structure - Use directory iterator to loop through all files and folders (makes generation more robust)
77 lines
2.7 KiB
Markdown
77 lines
2.7 KiB
Markdown
# WP_CLI::add_command()
|
|
|
|
Register a command to WP-CLI.
|
|
|
|
***
|
|
|
|
## Usage
|
|
|
|
WP_CLI::add_command( $name, $callable, $args = [] )
|
|
|
|
<div>
|
|
<strong>$name</strong> (string) Name for the command (e.g. "post list" or "site empty").<br />
|
|
<strong>$callable</strong> (callable|object|string) Command implementation as a class, function or closure.<br />
|
|
<strong>$args</strong> (array) {<br /> Optional. An associative array with additional registration parameters.<br /> @type callable $before_invoke Callback to execute before invoking the command.<br /> @type callable $after_invoke Callback to execute after invoking the command.<br /> @type string $shortdesc Short description (80 char or less) for the command.<br /> @type string $longdesc Description of arbitrary length for examples, etc.<br /> @type string $synopsis The synopsis for the command (string or array).<br /> @type string $when Execute callback on a named WP-CLI hook (e.g. before_wp_load).<br /> @type bool $is_deferred Whether the command addition had already been deferred.<br />}<br />
|
|
<strong>@return</strong> (bool) on success, false if deferred, hard error if registration failed.<br />
|
|
</div>
|
|
|
|
|
|
***
|
|
|
|
## Notes
|
|
|
|
WP-CLI supports using any callable class, function, or closure as a
|
|
command. `WP_CLI::add_command()` is used for both internal and
|
|
third-party command registration.
|
|
|
|
Command arguments are parsed from PHPDoc by default, but also can be
|
|
supplied as an optional third argument during registration.
|
|
|
|
```
|
|
# Register a custom 'foo' command to output a supplied positional param.
|
|
#
|
|
# $ wp foo bar --append=qux
|
|
# Success: bar qux
|
|
|
|
/**
|
|
* My awesome closure command
|
|
*
|
|
* <message>
|
|
* : An awesome message to display
|
|
*
|
|
* --append=<message>
|
|
* : An awesome message to append to the original message.
|
|
*
|
|
* @when before_wp_load
|
|
*/
|
|
$foo = function( $args, $assoc_args ) {
|
|
WP_CLI::success( $args[0] . ' ' . $assoc_args['append'] );
|
|
};
|
|
WP_CLI::add_command( 'foo', $foo );
|
|
```
|
|
|
|
|
|
*Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.*
|
|
|
|
|
|
***
|
|
|
|
## Related
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-add-hook/">WP_CLI::add_hook()</a></strong> - Schedule a callback to be executed at a certain point.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-do-hook/">WP_CLI::do_hook()</a></strong> - Execute callbacks registered to a given hook.</li>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-add-wp-hook/">WP_CLI::add_wp_hook()</a></strong> - Add a callback to a WordPress action or filter.</li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
