do_action
do_action ( $hook_name, $arg )
Parameters:- (string) hook_name The name of the action to be executed.
- (mixed) arg Optional. Additional arguments which are passed on to the functions hooked to the action. Default empty.
Defined at:Change Log: - Introduced in WordPress: 1.2.0
- Deprecated in WordPress: —
Description
Calls the callback functions that have been added to an action hook.This function invokes all functions attached to action hook `$hook_name`.
It is possible to create new action hooks by simply calling this function,
specifying the name of the new hook using the `$hook_name` parameter.
You can pass extra arguments to the hooks, much like you can with `apply_filters()`.
Example usage:
// The action callback function.
function example_callback( $arg1, $arg2 ) {
// (maybe) do something with the args.
}
add_action( 'example_action', 'example_callback', 10, 2 );
/*
* Trigger the actions by calling the 'example_callback()' function
* that's hooked onto `example_action` above.
*
* - 'example_action' is the action hook.
* - $arg1 and $arg2 are the additional arguments passed to the callback.
$value = do_action( 'example_action', $arg1, $arg2 );