_deprecated_hook() – Marks a deprecated action or filter hook as deprecated and throws a notice.

You appear to be a bot. Output may be restricted

Description

Marks a deprecated action or filter hook as deprecated and throws a notice.

Use the 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.

Usage

_deprecated_hook( $hook, $version, $replacement, $message );

Parameters

$hook
( string ) required – The hook that was used.
$version
( string ) required – The version of WordPress that deprecated the hook.
$replacement
( string ) optional – Optional. The hook that should have been used. Default empty.
$message
( string ) optional – Optional. A message regarding the change. Default empty.

Returns

void

Source

File name: wordpress/wp-includes/functions.php


Lines:

1 to 51 of 51
function _deprecated_hook( $hook, $version, $replacement = '', $message = '' ) {
  
/**
 * Fires when a deprecated hook is called.
 *
 * @since 4.6.0
 *
 * @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.
 *
 * @since 4.6.0
 *
 * @param bool $trigger Whether to trigger deprecated hook errors. Requires
 *                      `WP_DEBUG` to be defined true.
 */
  if ( WP_DEBUG && 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. */
          __( 'Hook %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. */
          __( 'Hook %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
          $hook,
          $version
        ) . $message,
        E_USER_DEPRECATED
      );
    }
  }
}
 

 View on GitHub View on Trac