Action hook 'example_action'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into example_action
add_action('example_action', 'my_custom_function', 10, 4);

function my_custom_function($hook_name, $callback, $priority, $accepted_args) {
    // Your custom code here
}

Source Code Context

<?php
 463   *      * Trigger the actions by calling the 'example_callback()' function
 464   *      * that's hooked onto `example_action` above.
 465   *      *
 466   *      * - 'example_action' is the action hook.
 467   *      * - $arg1 and $arg2 are the additional arguments passed to the callback.
 468   *     do_action( 'example_action', $arg1, $arg2 );
 469   *
 470   * @since 1.2.0
 471   * @since 5.3.0 Formalized the existing and already documented `...$arg` parameter
 472   *              by adding it to the function signature.
 473   *

PHP Documentation

<?php
/**
 * Adds a callback function to an action hook.
 *
 * Actions are the hooks that the WordPress core launches at specific points
 * during execution, or when specific events occur. Plugins can specify that
 * one or more of its PHP functions are executed at these points, using the
 * Action API.
 *
 * @since 1.2.0
 *
 * @param string   $hook_name       The name of the action to add the callback to.
 * @param callable $callback        The callback to be run when the action is called.
 * @param int      $priority        Optional. Used to specify the order in which the functions
 *                                  associated with a particular action are executed.
 *                                  Lower numbers correspond with earlier execution,
 *                                  and functions with the same priority are executed
 *                                  in the order in which they were added to the action. Default 10.
 * @param int      $accepted_args   Optional. The number of arguments the function accepts. Default 1.
 * @return true Always returns true.
 */