mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-04-30 02:31:45 +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)
83 lines
2.6 KiB
Markdown
83 lines
2.6 KiB
Markdown
# WP_CLI::add_hook()
|
|
|
|
Schedule a callback to be executed at a certain point.
|
|
|
|
***
|
|
|
|
## Usage
|
|
|
|
WP_CLI::add_hook( $when, $callback )
|
|
|
|
<div>
|
|
<strong>$when</strong> (string) Identifier for the hook.<br />
|
|
<strong>$callback</strong> (mixed) Callback to execute when hook is called.<br />
|
|
<strong>@return</strong> (void) <br />
|
|
</div>
|
|
|
|
|
|
***
|
|
|
|
## Notes
|
|
|
|
Hooks conceptually are very similar to WordPress actions. WP-CLI hooks
|
|
are typically called before WordPress is loaded.
|
|
|
|
WP-CLI hooks include:
|
|
|
|
* `before_add_command:<command>` - Before the command is added.
|
|
* `after_add_command:<command>` - After the command was added.
|
|
* `before_invoke:<command>` (1) - Just before a command is invoked.
|
|
* `after_invoke:<command>` (1) - Just after a command is invoked.
|
|
* `find_command_to_run_pre` - Just before WP-CLI finds the command to run.
|
|
* `before_registering_contexts` (1) - Before the contexts are registered.
|
|
* `before_wp_load` - Just before the WP load process begins.
|
|
* `before_wp_config_load` - After wp-config.php has been located.
|
|
* `after_wp_config_load` - After wp-config.php has been loaded into scope.
|
|
* `after_wp_load` - Just after the WP load process has completed.
|
|
* `before_run_command` (3) - Just before the command is executed.
|
|
|
|
The parentheses behind the hook name denote the number of arguments
|
|
being passed into the hook. For such hooks, the callback should return
|
|
the first argument again, making them work like a WP filter.
|
|
|
|
WP-CLI commands can create their own hooks with `WP_CLI::do_hook()`.
|
|
|
|
If additional arguments are passed through the `WP_CLI::do_hook()` call,
|
|
these will be passed on to the callback provided by `WP_CLI::add_hook()`.
|
|
|
|
```
|
|
# `wp network meta` confirms command is executing in multisite context.
|
|
WP_CLI::add_command( 'network meta', 'Network_Meta_Command', array(
|
|
'before_invoke' => function ( $name ) {
|
|
if ( !is_multisite() ) {
|
|
WP_CLI::error( 'This is not a multisite installation.' );
|
|
}
|
|
}
|
|
) );
|
|
```
|
|
|
|
|
|
*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-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>
|
|
|
|
|
|
<li><strong><a href="https://make.wordpress.org/cli/handbook/internal-api/wp-cli-add-command/">WP_CLI::add_command()</a></strong> - Register a command to WP-CLI.</li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
