_deprecated_function

Mark a function as deprecated and inform when it has been used.

Description

_deprecated_function( (string) $function, (string) $version, (null) $replacement = null ); 

There is a that will be called that can be used to get the backtrace up to what file and function called the deprecated function.

The current behavior is to trigger a user error if WP_DEBUG is true.

This function is to be used in every function that is deprecated.

Parameters (3)

0. $function (string)
The function that was called.
1. $version (string)
The version of WordPress that deprecated the function.
2. $replacement — Optional. (null) => null
The function that should have been called. Default null.

Usage

  1. if ( !function_exists( '_deprecated_function' ) ) { 
  2.     require_once ABSPATH . WPINC . '/functions.php'; 
  3. } 
  4.   
  5. // The function that was called. 
  6. $function = ''; 
  7.   
  8. // The version of WordPress that deprecated the function. 
  9. $version = ''; 
  10.   
  11. // Optional. The function that should have been called. Default null. 
  12. $replacement = null; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = _deprecated_function($function, $version, $replacement); 
  16.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/functions.php  
  1. function _deprecated_function( $function, $version, $replacement = null ) { 
  2.  
  3.     /** 
  4.      * Fires when a deprecated function is called. 
  5.      * 
  6.      * @since 2.5.0 
  7.      * 
  8.      * @param string $function    The function that was called. 
  9.      * @param string $replacement The function that should have been called. 
  10.      * @param string $version     The version of WordPress that deprecated the function. 
  11.      */ 
  12.     do_action( 'deprecated_function_run', $function, $replacement, $version ); 
  13.  
  14.     /** 
  15.      * Filters whether to trigger anerrorfor deprecated functions. 
  16.      * 
  17.      * @since 2.5.0 
  18.      * 
  19.      * @param bool $trigger Whether to trigger theerrorfor deprecated functions. Default true. 
  20.      */ 
  22.         if ( function_exists( '__' ) ) { 
  23.             if ( ! is_null( $replacement ) ) { 
  24.                 /** translators: 1: PHP function name, 2: version number, 3: alternative function name */ 
  25.                 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) ); 
  26.             } else { 
  27.                 /** translators: 1: PHP function name, 2: version number */ 
  28.                 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) ); 
  29.             } 
  30.         } else { 
  31.             if ( ! is_null( $replacement ) ) { 
  32.                 trigger_error( sprintf( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', $function, $version, $replacement ) ); 
  33.             } else { 
  34.                 trigger_error( sprintf( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', $function, $version ) ); 
  35.             } 
  36.         } 
  37.     } 
  38. }