_doing_it_wrong
Mark something as being incorrectly called.
Description
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
if ( !function_exists( '_doing_it_wrong' ) ) { require_once ABSPATH . WPINC . '/functions.php'; } // The function that was called. $function = ''; // A message explaining what has been done incorrectly. $message = ''; // The version of WordPress where the message was added. $version = ''; // NOTICE! Understand what this does before running. $result = _doing_it_wrong($function, $message, $version);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/functions.php
- function _doing_it_wrong( $function, $message, $version ) {
- /**
- * Fires when the given function is being used incorrectly.
- *
- * @since 3.1.0
- *
- * @param string $function The function that was called.
- * @param string $message A message explaining what has been done incorrectly.
- * @param string $version The version of WordPress where the message was added.
- */
- do_action( 'doing_it_wrong_run', $function, $message, $version );
- /**
- * Filters whether to trigger anerrorfor _doing_it_wrong() calls.
- *
- * @since 3.1.0
- *
- * @param bool $trigger Whether to trigger theerrorfor _doing_it_wrong() calls. Default true.
- */
- if ( function_exists( '__' ) ) {
- if ( is_null( $version ) ) {
- $version = '';
- } else {
- /** translators: %s: version number */
- $version = sprintf( __( '(This message was added in version %s.)' ), $version );
- }
- /** translators: %s: Codex URL */
- $message .= ' ' . sprintf( __( 'Please see <a href="%s">Debugging in WordPress</a> for more information.' ),
- __( 'https://codex.wordpress.org/Debugging_in_WordPress' )
- );
- /** translators: Developer debugging message. 1: PHP function name, 2: Explanatory message, 3: Version information message */
- trigger_error( sprintf( __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ), $function, $message, $version ) );
- } else {
- if ( is_null( $version ) ) {
- $version = '';
- } else {
- $version = sprintf( '(This message was added in version %s.)', $version );
- }
- $message .= sprintf( ' Please see <a href="%s">Debugging in WordPress</a> for more information.',
- 'https://codex.wordpress.org/Debugging_in_WordPress'
- );
- trigger_error( sprintf( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s', $function, $message, $version ) );
- }
- }
- }