ActionHooks.php

<?php

/**
 * I love WordPressfor this
 */
/**
 * The API callback examples reference functions, but can be methods of classes.
 * To hook methods, you'll need to pass an array one of two ways.
 *
 * Any of the syntaxes explained in the PHP documentation for the
 * {@link https://www.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback'}
 * type are valid.
 * 
 * This file should have no external dependencies.
 *
 */

use SimpleMediaCode\Hooks\WP_Hook;

/**
 * 
 * @todo remove gloals
 */

/**
 * @var WP_Hook[] $wphook_filter 
 * */
global $wphook_filter;

/** @var int[] $wphook_actions */
global $wphook_actions;

/** @var string[] $wphook_current_filter */
global $wphook_current_filter;

if ($wphook_filter) {
	$wphook_filter = WP_Hook::build_preinitialized_hooks($wphook_filter);
} else {
	$wphook_filter = [];
}

if (!isset($wphook_actions)) {
	$wphook_actions = [];
}

if (!isset($wphook_current_filter)) {
	$wphook_current_filter = [];
}


if (!function_exists('add_filter')) {
	/**
	 * Hook a function or method to a specific filter action.
	 *
	 * WordPress offers filter hooks to allow plugins to modify
	 * various types of internal data at runtime.
	 *
	 * A plugin can modify data by binding a callback to a filter hook. When the filter
	 * is later applied, each bound callback is run in order of priority, and given
	 * the opportunity to modify a value by returning a new value.
	 *
	 * The following example shows how a callback function is bound to a filter hook.
	 *
	 * Note that `$example` is passed to the callback, (maybe) modified, then returned:
	 *
	 *     function example_callback( $example ) {
	 *         // Maybe modify $example in some way.
	 *         return $example;
	 *     }
	 *     add_filter( 'example_filter', 'example_callback' );
	 *
	 * Bound callbacks can accept from none to the total number of arguments passed as parameters
	 * in the corresponding apply_filters() call.
	 *
	 * In other words, if an apply_filters() call passes four total arguments, callbacks bound to
	 * it can accept none (the same as 1) of the arguments or up to four. The important part is that
	 * the `$accepted_args` value must reflect the number of arguments the bound callback *actually*
	 * opted to accept. If no arguments were accepted by the callback that is considered to be the
	 * same as accepting 1 argument. For example:
	 *
	 *     // Filter call.
	 *     $value = apply_filters( 'hook', $value, $arg2, $arg3 );
	 *
	 *     // Accepting zero/one arguments.
	 *     function example_callback() {
	 *         ...
	 *         return 'some value';
	 *     }
	 *     add_filter( 'hook', 'example_callback' ); // Where $priority is default 10, $accepted_args is default 1.
	 *
	 *     // Accepting two arguments (three possible).
	 *     function example_callback( $value, $arg2 ) {
	 *         ...
	 *         return $maybe_modified_value;
	 *     }
	 *     add_filter( 'hook', 'example_callback', 10, 2 ); // Where $priority is 10, $accepted_args is 2.
	 *
	 * *Note:* The function will return true whether or not the callback is valid.
	 * It is up to you to take care. This is done for optimization purposes, so
	 * everything is as quick as possible.
	 *
	 *
	 * @global WP_Hook[] $wphook_filter A multidimensional array of all hooks and the callbacks hooked to them.
	 *
	 * @param string   $tag             The name of the filter to hook the $function_to_add callback to.
	 * @param callable $function_to_add The callback to be run when the filter is applied.
	 * @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
	 */
	function add_filter($tag, $function_to_add, $priority = 10, $accepted_args = 1)
	{
		global $wphook_filter;
		if (!isset($wphook_filter[$tag])) {
			$wphook_filter[$tag] = new WP_Hook();
		}
		$wphook_filter[$tag]->add_filter($tag, $function_to_add, $priority, $accepted_args);
		return true;
	}
}

if (!function_exists('has_filter')) {
	/**
	 * Check if any filter has been registered for a hook.
	 *
	 *
	 * @global WP_Hook[] $wphook_filter Stores all of the filters and actions.
	 *
	 * @param string        $tag               The name of the filter hook.
	 * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
	 * @return false|int If $function_to_check is omitted, returns boolean for whether the hook has
	 *                   anything registered. When checking a specific function, the priority of that
	 *                   hook is returned, or false if the function is not attached. When using the
	 *                   $function_to_check argument, this function may return a non-boolean value
	 *                   that evaluates to false (e.g.) 0, so use the === operator for testing the
	 *                   return value.
	 */
	function has_filter($tag, $function_to_check = false)
	{
		global $wphook_filter;

		if (!isset($wphook_filter[$tag])) {
			return false;
		}

		return $wphook_filter[$tag]->has_filter($tag, $function_to_check);
	}
}


if (!function_exists('apply_filters')) {
	/**
	 * Calls the callback functions that have been added to a filter hook.
	 *
	 * The callback functions attached to the filter hook are invoked by calling
	 * this function. This function can be used to create a new filter hook by
	 * simply calling this function with the name of the new hook specified using
	 * the `$tag` parameter.
	 *
	 * The function also allows for multiple additional arguments to be passed to hooks.
	 *
	 * Example usage:
	 *
	 *     // The filter callback function.
	 *     function example_callback( $string, $arg1, $arg2 ) {
	 *         // (maybe) modify $string.
	 *         return $string;
	 *     }
	 *     add_filter( 'example_filter', 'example_callback', 10, 3 );
	 *
	 *     /*
	 *      * Apply the filters by calling the 'example_callback()' function
	 *      * that's hooked onto `example_filter` above.
	 *      *
	 *      * - 'example_filter' is the filter hook.
	 *      * - 'filter me' is the value being filtered.
	 *      * - $arg1 and $arg2 are the additional arguments passed to the callback.
	 *     $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
	 *
	 *
	 * @global WP_Hook[] $wphook_filter         Stores all of the filters and actions.
	 * @global string[]  $wphook_current_filter Stores the list of current filters with the current one last.
	 *
	 * @param string $tag     The name of the filter hook.
	 * @param mixed  $value   The value to filter.
	 * @param mixed  ...$args Additional parameters to pass to the callback functions.
	 * @return mixed The filtered value after all hooked functions are applied to it.
	 */
	function apply_filters($tag, $value)
	{
		global $wphook_filter, $wphook_current_filter;

		$args = func_get_args();

		// Do 'all' actions first.
		if (isset($wphook_filter['all'])) {
			$wphook_current_filter[] = $tag;
			wp_call_all_hook($args);
		}

		if (!isset($wphook_filter[$tag])) {
			if (isset($wphook_filter['all'])) {
				array_pop($wphook_current_filter);
			}
			return $value;
		}

		if (!isset($wphook_filter['all'])) {
			$wphook_current_filter[] = $tag;
		}

		// Don't pass the tag name to WP_Hook.
		array_shift($args);

		$filtered = $wphook_filter[$tag]->apply_filters($value, $args);

		array_pop($wphook_current_filter);

		return $filtered;
	}
}

if (!function_exists('apply_filters_ref_array')) {
	/**
	 * Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
	 *
	 *
	 * @see apply_filters() This function is identical, but the arguments passed to the
	 * functions hooked to `$tag` are supplied using an array.
	 *
	 * @global WP_Hook[] $wphook_filter         Stores all of the filters and actions.
	 * @global string[]  $wphook_current_filter Stores the list of current filters with the current one last.
	 *
	 * @param string $tag  The name of the filter hook.
	 * @param array  $args The arguments supplied to the functions hooked to $tag.
	 * @return mixed The filtered value after all hooked functions are applied to it.
	 */
	function apply_filters_ref_array($tag, $args)
	{
		global $wphook_filter, $wphook_current_filter;

		// Do 'all' actions first.
		if (isset($wphook_filter['all'])) {
			$wphook_current_filter[] = $tag;
			$all_args            = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
			wp_call_all_hook($all_args);
		}

		if (!isset($wphook_filter[$tag])) {
			if (isset($wphook_filter['all'])) {
				array_pop($wphook_current_filter);
			}
			return $args[0];
		}

		if (!isset($wphook_filter['all'])) {
			$wphook_current_filter[] = $tag;
		}

		$filtered = $wphook_filter[$tag]->apply_filters($args[0], $args);

		array_pop($wphook_current_filter);

		return $filtered;
	}
}

if (!function_exists('remove_filter')) {
	/**
	 * Removes a function from a specified filter hook.
	 *
	 * This function removes a function attached to a specified filter hook. This
	 * method can be used to remove default functions attached to a specific filter
	 * hook and possibly replace them with a substitute.
	 *
	 * To remove a hook, the $function_to_remove and $priority arguments must match
	 * when the hook was added. This goes for both filters and actions. No warning
	 * will be given on removal failure.
	 *
	 *
	 * @global WP_Hook[] $wphook_filter Stores all of the filters and actions.
	 *
	 * @param string   $tag                The filter hook to which the function to be removed is hooked.
	 * @param callable $function_to_remove The name of the function which should be removed.
	 * @param int      $priority           Optional. The priority of the function. Default 10.
	 * @return bool    Whether the function existed before it was removed.
	 */
	function remove_filter($tag, $function_to_remove, $priority = 10)
	{
		global $wphook_filter;

		$r = false;
		if (isset($wphook_filter[$tag])) {
			$r = $wphook_filter[$tag]->remove_filter($tag, $function_to_remove, $priority);
			if (!$wphook_filter[$tag]->callbacks) {
				unset($wphook_filter[$tag]);
			}
		}

		return $r;
	}
}

if (!function_exists('remove_all_filters')) {
	/**
	 * Remove all of the hooks from a filter.
	 *
	 *
	 * @global WP_Hook[] $wphook_filter Stores all of the filters and actions.
	 *
	 * @param string   $tag      The filter to remove hooks from.
	 * @param int|bool $priority Optional. The priority number to remove. Default false.
	 * @return true True when finished.
	 */
	function remove_all_filters($tag, $priority = false)
	{
		global $wphook_filter;

		if (isset($wphook_filter[$tag])) {
			$wphook_filter[$tag]->remove_all_filters($priority);
			if (!$wphook_filter[$tag]->has_filters()) {
				unset($wphook_filter[$tag]);
			}
		}

		return true;
	}
}

if (!function_exists('current_filter')) {
	/**
	 * Retrieve the name of the current filter or action.
	 *
	 *
	 * @global string[] $wphook_current_filter Stores the list of current filters with the current one last
	 *
	 * @return string Hook name of the current filter or action.
	 */
	function current_filter()
	{
		global $wphook_current_filter;
		return end($wphook_current_filter);
	}
}

if (!function_exists('current_action')) {
	/**
	 * Retrieve the name of the current action.
	 *
	 * @since 3.9.0
	 *
	 * @return string Hook name of the current action.
	 */
	function current_action()
	{
		return current_filter();
	}
}

if (!function_exists('doing_filter')) {

	/**
	 * Retrieve the name of a filter currently being processed.
	 *
	 * The function current_filter() only returns the most recent filter or action
	 * being executed. did_action() returns true once the action is initially
	 * processed.
	 *
	 * This function allows detection for any filter currently being
	 * executed (despite not being the most recent filter to fire, in the case of
	 * hooks called from hook callbacks) to be verified.
	 *
	 *
	 * @see current_filter()
	 * @see did_action()
	 * @global string[] $wphook_current_filter Current filter.
	 *
	 * @param null|string $filter Optional. Filter to check. Defaults to null, which
	 *                            checks if any filter is currently being run.
	 * @return bool Whether the filter is currently in the stack.
	 */
	function doing_filter($filter = null)
	{
		global $wphook_current_filter;

		if (null === $filter) {
			return !empty($wphook_current_filter);
		}

		return in_array($filter, $wphook_current_filter, true);
	}
}

if (!function_exists('doing_action')) {
	/**
	 * Retrieve the name of an action currently being processed.
	 * 
	 * @param string|null $action Optional. Action to check. Defaults to null, which checks
	 *                            if any action is currently being run.
	 * @return bool Whether the action is currently in the stack.
	 */
	function doing_action($action = null)
	{
		return doing_filter($action);
	}
}

if (!function_exists('add_action')) {
	/**
	 * Hooks a function on to a specific action.
	 *
	 * 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.
	 *
	 *
	 * @param string   $tag             The name of the action to which the $function_to_add is hooked.
	 * @param callable $function_to_add The name of the function you wish to be called.
	 * @param int      $priority        Optional. Used to specify the order in which the functions
	 *                                  associated with a particular action are executed. Default 10.
	 *                                  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.
	 * @param int      $accepted_args   Optional. The number of arguments the function accepts. Default 1.
	 * @return true Will always return true.
	 */
	function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1)
	{
		return add_filter($tag, $function_to_add, $priority, $accepted_args);
	}
}

if (!function_exists('do_action')) {
	/**
	 * Execute functions hooked on a specific action hook.
	 *
	 * This function invokes all functions attached to action hook `$tag`. It is
	 * possible to create new action hooks by simply calling this function,
	 * specifying the name of the new hook using the `$tag` 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 );
	 *
	 *
	 * @global WP_Hook[] $wphook_filter         Stores all of the filters and actions.
	 * @global int[]     $wphook_actions        Stores the number of times each action was triggered.
	 * @global string[]  $wphook_current_filter Stores the list of current filters with the current one last.
	 *
	 * @param string $tag    The name of the action to be executed.
	 * @param mixed  ...$arg Optional. Additional arguments which are passed on to the
	 *                       functions hooked to the action. Default empty.
	 */
	function do_action($tag, ...$arg)
	{
		global $wphook_filter, $wphook_actions, $wphook_current_filter;

		if (!isset($wphook_actions[$tag])) {
			$wphook_actions[$tag] = 1;
		} else {
			++$wphook_actions[$tag];
		}

		// Do 'all' actions first.
		if (isset($wphook_filter['all'])) {
			$wphook_current_filter[] = $tag;
			$all_args            = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
			wp_call_all_hook($all_args);
		}

		if (!isset($wphook_filter[$tag])) {
			if (isset($wphook_filter['all'])) {
				array_pop($wphook_current_filter);
			}
			return;
		}

		if (!isset($wphook_filter['all'])) {
			$wphook_current_filter[] = $tag;
		}

		if (empty($arg)) {
			$arg[] = '';
		} elseif (is_array($arg[0]) && 1 === count($arg[0]) && isset($arg[0][0]) && is_object($arg[0][0])) {
			// Backward compatibility for PHP4-style passing of `array( &$this )` as action `$arg`.
			$arg[0] = $arg[0][0];
		}

		$wphook_filter[$tag]->do_action($arg);

		array_pop($wphook_current_filter);
	}
}

if (!function_exists('did_action')) {
	/**
	 * Retrieve the number of times an action is fired.
	 *
	 *
	 * @global int[] $wphook_actions Stores the number of times each action was triggered.
	 *
	 * @param string $tag The name of the action hook.
	 * @return int The number of times action hook $tag is fired.
	 */
	function did_action($tag)
	{
		global $wphook_actions;

		if (!isset($wphook_actions[$tag])) {
			return 0;
		}

		return $wphook_actions[$tag];
	}
}

if (!function_exists('do_action_ref_array')) {
	/**
	 * Calls the callback functions that have been added to an action hook, specifying arguments in an array.
	 *
	 *
	 * @see do_action() This function is identical, but the arguments passed to the
	 *                  functions hooked to `$tag` are supplied using an array.
	 *
	 * @global WP_Hook[] $wphook_filter         Stores all of the filters and actions.
	 * @global int[]     $wphook_actions        Stores the number of times each action was triggered.
	 * @global string[]  $wphook_current_filter Stores the list of current filters with the current one last.
	 *
	 * @param string $tag  The name of the action to be executed.
	 * @param array  $args The arguments supplied to the functions hooked to `$tag`.
	 */
	function do_action_ref_array($tag, $args)
	{
		global $wphook_filter, $wphook_actions, $wphook_current_filter;

		if (!isset($wphook_actions[$tag])) {
			$wphook_actions[$tag] = 1;
		} else {
			++$wphook_actions[$tag];
		}

		// Do 'all' actions first.
		if (isset($wphook_filter['all'])) {
			$wphook_current_filter[] = $tag;
			$all_args            = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
			wp_call_all_hook($all_args);
		}

		if (!isset($wphook_filter[$tag])) {
			if (isset($wphook_filter['all'])) {
				array_pop($wphook_current_filter);
			}
			return;
		}

		if (!isset($wphook_filter['all'])) {
			$wphook_current_filter[] = $tag;
		}

		$wphook_filter[$tag]->do_action($args);

		array_pop($wphook_current_filter);
	}
}

if (!function_exists('has_action')) {
	/**
	 * Check if any action has been registered for a hook.
	 *
	 *
	 * @see has_filter() has_action() is an alias of has_filter().
	 *
	 * @param string        $tag               The name of the action hook.
	 * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
	 * @return bool|int If $function_to_check is omitted, returns boolean for whether the hook has
	 *                  anything registered. When checking a specific function, the priority of that
	 *                  hook is returned, or false if the function is not attached. When using the
	 *                  $function_to_check argument, this function may return a non-boolean value
	 *                  that evaluates to false (e.g.) 0, so use the === operator for testing the
	 *                  return value.
	 */
	function has_action($tag, $function_to_check = false)
	{
		return has_filter($tag, $function_to_check);
	}
}
if (!function_exists('remove_action')) {
	/**
	 * Removes a function from a specified action hook.
	 *
	 * This function removes a function attached to a specified action hook. This
	 * method can be used to remove default functions attached to a specific filter
	 * hook and possibly replace them with a substitute.
	 *
	 *
	 * @param string   $tag                The action hook to which the function to be removed is hooked.
	 * @param callable $function_to_remove The name of the function which should be removed.
	 * @param int      $priority           Optional. The priority of the function. Default 10.
	 * @return bool Whether the function is removed.
	 */
	function remove_action($tag, $function_to_remove, $priority = 10)
	{
		return remove_filter($tag, $function_to_remove, $priority);
	}
}

if (!function_exists('remove_all_actions')) {
	/**
	 * Remove all of the hooks from an action.
	 *
	 * @param string   $tag      The action to remove hooks from.
	 * @param int|bool $priority The priority number to remove them from. Default false.
	 * @return true True when finished.
	 */
	function remove_all_actions($tag, $priority = false)
	{
		return remove_all_filters($tag, $priority);
	}
}

if (!function_exists('apply_filters_deprecated')) {
	/**
	 * Fires functions attached to a deprecated filter hook.
	 *
	 * When a filter hook is deprecated, the apply_filters() call is replaced with
	 * apply_filters_deprecated(), which triggers a deprecation notice and then fires
	 * the original filter hook.
	 *
	 * Note: the value and extra arguments passed to the original apply_filters() call
	 * must be passed here to `$args` as an array. For example:
	 *
	 *     // Old filter.
	 *     return apply_filters( 'wpdocs_filter', $value, $extra_arg );
	 *
	 *     // Deprecated.
	 *     return apply_filters_deprecated( 'wpdocs_filter', array( $value, $extra_arg ), '4.9.0', 'wpdocs_new_filter' );
	 *
	 * @see deprecated_hook()
	 *
	 * @param string $tag         The name of the filter hook.
	 * @param array  $args        Array of additional function arguments to be passed to apply_filters().
	 * @param string $version     The version of WordPress that deprecated the hook.
	 * @param string $replacement Optional. The hook that should have been used. Default empty.
	 * @param string $message     Optional. A message regarding the change. Default empty.
	 */
	function apply_filters_deprecated($tag, $args, $version, $replacement = '', $message = '')
	{
		if (!has_filter($tag)) {
			return $args[0];
		}

		deprecated_hook($tag, $version, $replacement, $message);

		return apply_filters_ref_array($tag, $args);
	}
}

if (!function_exists('do_action_deprecated')) {
	/**
	 * Fires functions attached to a deprecated action hook.
	 *
	 * When an action hook is deprecated, the do_action() call is replaced with
	 * do_action_deprecated(), which triggers a deprecation notice and then fires
	 * the original hook.
	 *
	 * @see deprecated_hook()
	 *
	 * @param string $tag         The name of the action hook.
	 * @param array  $args        Array of additional function arguments to be passed to do_action().
	 * @param string $version     The version of WordPress that deprecated the hook.
	 * @param string $replacement Optional. The hook that should have been used. Default empty.
	 * @param string $message     Optional. A message regarding the change. Default empty.
	 */
	function do_action_deprecated($tag, $args, $version, $replacement = '', $message = '')
	{
		if (!has_action($tag)) {
			return;
		}

		deprecated_hook($tag, $version, $replacement, $message);
		do_action_ref_array($tag, $args);
	}
}

if (!function_exists('wp_call_all_hook')) {
	/**
	 * Call the 'all' hook, which will process the functions hooked into it.
	 *
	 * The 'all' hook passes all of the arguments or parameters that were used for
	 * the hook, which this function was called for.
	 *
	 * This function is used internally for apply_filters(), do_action(), and
	 * do_action_ref_array() and is not meant to be used from outside those
	 * functions. This function does not check for the existence of the all hook, so
	 * it will fail unless the all hook exists prior to this function call.
	 * @access private
	 *
	 * @global WP_Hook[] $wphook_filter Stores all of the filters and actions.
	 *
	 * @param array $args The collected parameters from the hook that was called.
	 */
	function wp_call_all_hook($args)
	{
		global $wphook_filter;

		$wphook_filter['all']->do_all_hook($args);
	}
}

if (!function_exists('deprecated_hook')) {
	/**
	 * Marks a deprecated action or filter hook as deprecated and throws a notice.
	 *
	 * Use the {@see 'deprecated_hook_run'} action to get the backtrace describing where
	 * the deprecated hook was called.
	 *
	 * Default behavior is to trigger a user error if `WP_DEBUG` is true.
	 *
	 * This function is called by the do_action_deprecated() and apply_filters_deprecated()
	 * functions, and so generally does not need to be called directly.
	 * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
	 * @access private
	 *
	 * @param string $hook        The hook that was used.
	 * @param string $version     The version of WordPress that deprecated the hook.
	 * @param string $replacement Optional. The hook that should have been used. Default empty.
	 * @param string $message     Optional. A message regarding the change. Default empty.
	 */
	function deprecated_hook($hook, $version, $replacement = '', $message = '')
	{
		/**
		 * Fires when a deprecated hook is called.
		 *
		 * @param string $hook        The hook that was called.
		 * @param string $replacement The hook that should be used as a replacement.
		 * @param string $version     The version of WordPress that deprecated the argument used.
		 * @param string $message     A message regarding the change.
		 */
		do_action('deprecated_hook_run', $hook, $replacement, $version, $message);

		/**
		 * Filters whether to trigger deprecated hook errors.
		 *
		 * @param bool $trigger Whether to trigger deprecated hook errors. Requires
		 *                      `WP_DEBUG` to be defined true.
		 */
		if (apply_filters('deprecated_hook_trigger_error', true)) {
			$message = empty($message) ? '' : ' ' . $message;

			if ($replacement) {
				trigger_error(
					sprintf(
						/* translators: 1: WordPress hook name, 2: Version number, 3: Alternative hook name. */
						'%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
						$hook,
						$version,
						$replacement
					) . $message,
					E_USER_DEPRECATED
				);
			} else {
				trigger_error(
					sprintf(
						/* translators: 1: WordPress hook name, 2: Version number. */
						'%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.',
						$hook,
						$version
					) . $message,
					E_USER_DEPRECATED
				);
			}
		}
	}
}