_doing_it_wrong

Mark something as being incorrectly called.

Description

_doing_it_wrong( (string) $function, (string) $message, (string) $version ); 

There is a hook 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.

Parameters (3)

0. $function (string)
The function that was called.
1. $message (string)
A message explaining what has been done incorrectly.
2. $version (string)
The version of WordPress where the message was added.

Usage

  1. if ( !function_exists( '_doing_it_wrong' ) ) { 
  2.     require_once ABSPATH . WPINC . '/functions.php'; 
  3. } 
  4.   
  5. // The function that was called. 
  6. $function = ''; 
  7.   
  8. // A message explaining what has been done incorrectly. 
  9. $message = ''; 
  10.   
  11. // The version of WordPress where the message was added. 
  12. $version = ''; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = _doing_it_wrong($function, $message, $version); 
  16.     

Defined (1)

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

/wp-includes/functions.php  
  1. function _doing_it_wrong( $function, $message, $version ) { 
  2.  
  3.     /** 
  4.      * Fires when the given function is being used incorrectly. 
  5.      * 
  6.      * @since 3.1.0 
  7.      * 
  8.      * @param string $function The function that was called. 
  9.      * @param string $message  A message explaining what has been done incorrectly. 
  10.      * @param string $version  The version of WordPress where the message was added. 
  11.      */ 
  12.     do_action( 'doing_it_wrong_run', $function, $message, $version ); 
  13.  
  14.     /** 
  15.      * Filters whether to trigger anerrorfor _doing_it_wrong() calls. 
  16.      * 
  17.      * @since 3.1.0 
  18.      * 
  19.      * @param bool $trigger Whether to trigger theerrorfor _doing_it_wrong() calls. Default true. 
  20.      */ 
  22.         if ( function_exists( '__' ) ) { 
  23.             if ( is_null( $version ) ) { 
  24.                 $version = ''; 
  25.             } else { 
  26.                 /** translators: %s: version number */ 
  27.                 $version = sprintf( __( '(This message was added in version %s.)' ), $version ); 
  28.             } 
  29.             /** translators: %s: Codex URL */ 
  30.             $message .= ' ' . sprintf( __( 'Please see <a href="%s">Debugging in WordPress</a> for more information.' ),  
  31.                 __( 'https://codex.wordpress.org/Debugging_in_WordPress' ) 
  32.  ); 
  33.             /** translators: Developer debugging message. 1: PHP function name, 2: Explanatory message, 3: Version information message */ 
  34.             trigger_error( sprintf( __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ), $function, $message, $version ) ); 
  35.         } else { 
  36.             if ( is_null( $version ) ) { 
  37.                 $version = ''; 
  38.             } else { 
  39.                 $version = sprintf( '(This message was added in version %s.)', $version ); 
  40.             } 
  41.             $message .= sprintf( ' Please see <a href="%s">Debugging in WordPress</a> for more information.',  
  42.                 'https://codex.wordpress.org/Debugging_in_WordPress' 
  43.  ); 
  44.             trigger_error( sprintf( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s', $function, $message, $version ) ); 
  45.         } 
  46.     } 
  47. }