_doing_it_wrong() – Mark something as being incorrectly called.

You appear to be a bot. Output may be restricted

Description

Mark something as being incorrectly called.

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

Usage

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

Parameters

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

Returns

void

Source

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


Lines:

1 to 72 of 72
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 an error for _doing_it_wrong() calls.
 *
 * @since 3.1.0
 * @since 5.1.0 Added the $function, $message and $version parameters.
 *
 * @param bool   $trigger  Whether to trigger the error for _doing_it_wrong() calls. Default true.
 * @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.
 */
  if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true, $function, $message, $version ) ) {
    if ( function_exists( '__' ) ) {
      if ( $version ) {
        /* translators: %s: Version number. */
        $version = sprintf( __( '(This message was added in version %s.)' ), $version );
      }

      $message .= ' ' . sprintf(
        /* translators: %s: Documentation URL. */
        __( 'Please see <a href="%s">Debugging in WordPress</a> for more information.' ),
        __( 'https://wordpress.org/support/article/debugging-in-wordpress/' )
      );

      trigger_error(
        sprintf(
          /* translators: Developer debugging message. 1: PHP function name, 2: Explanatory message, 3: WordPress version number. */
          __( 'Function %1$s was called <strong>incorrectly</strong>. %2$s %3$s' ),
          $function,
          $message,
          $version
        ),
        E_USER_NOTICE
      );
    } else {
      if ( $version ) {
        $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://wordpress.org/support/article/debugging-in-wordpress/'
      );

      trigger_error(
        sprintf(
          'Function %1$s was called <strong>incorrectly</strong>. %2$s %3$s',
          $function,
          $message,
          $version
        ),
        E_USER_NOTICE
      );
    }
  }
}
 

 View on GitHub View on Trac