_doing_it_wrong( string $function_name, string $message, string $version )

Description

Parameters

$function_namestring

The function that was called.

$messagestring

A message explaining what has been done incorrectly.

$versionstring

The version of WordPress where the message was added.

Hooks fired · 2

2 hooks fire while _doing_it_wrong() runs, in this order:

1. 1
   do_action( doing_it_wrong_run )actionline 6003 (+11 into the body)

   Fires when the given function is being used incorrectly.

2. 2
   apply_filters( doing_it_wrong_trigger_error )filterline 6016 (+24 into the body)

   Filters whether to trigger an error for _doing_it_wrong() calls.

Uses · 4

• do_action()Calls the callback functions that have been added to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.

Used by · 50

• WP_Admin_Bar::add_node()Adds a node to the menu.
• WP_Automatic_Updater::is_allowed_dir()Checks whether access to a given directory is allowed.
• WP_Block_Bindings_Registry::register()Registers a new block bindings source.
• WP_Block_Bindings_Registry::unregister()Unregisters a block bindings source.
• WP_Block_Metadata_Registry::register_collection()Registers a block metadata collection.
• WP_Block_Pattern_Categories_Registry::register()Registers a pattern category.
• WP_Block_Pattern_Categories_Registry::unregister()Unregisters a pattern category.
• WP_Block_Patterns_Registry::register()Registers a block pattern.
• WP_Block_Patterns_Registry::unregister()Unregisters a block pattern.
• WP_Block_Styles_Registry::register()Registers a block style for the given block type.
• WP_Block_Styles_Registry::unregister()Unregisters a block style of the given block type.
• WP_Block_Templates_Registry::register()Registers a template.

Source

View on Trac ↗View on GitHub ↗

5992function _doing_it_wrong( $function_name, $message, $version ) {5993 5994	/**5995	 * Fires when the given function is being used incorrectly.5996	 *5997	 * @since 3.1.05998	 *5999	 * @param string $function_name The function that was called.6000	 * @param string $message       A message explaining what has been done incorrectly.6001	 * @param string $version       The version of WordPress where the message was added.6002	 */6003	do_action( 'doing_it_wrong_run', $function_name, $message, $version );6004 6005	/**6006	 * Filters whether to trigger an error for _doing_it_wrong() calls.6007	 *6008	 * @since 3.1.06009	 * @since 5.1.0 Added the $function_name, $message and $version parameters.6010	 *6011	 * @param bool   $trigger       Whether to trigger the error for _doing_it_wrong() calls. Default true.6012	 * @param string $function_name The function that was called.6013	 * @param string $message       A message explaining what has been done incorrectly.6014	 * @param string $version       The version of WordPress where the message was added.6015	 */6016	if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true, $function_name, $message, $version ) ) {6017		if ( function_exists( '__' ) ) {6018			if ( $version ) {6019				/* translators: %s: Version number. */6020				$version = sprintf( __( '(This message was added in version %s.)' ), $version );6021			}6022 6023			$message .= ' ' . sprintf(6024				/* translators: %s: Documentation URL. */6025				__( 'Please see <a href="%s">Debugging in WordPress</a> for more information.' ),6026				__( 'https://developer.wordpress.org/advanced-administration/debug/debug-wordpress/' )6027			);6028 6029			$message = sprintf(6030				/* translators: Developer debugging message. 1: PHP function name, 2: Explanatory message, 3: WordPress version number. */6031				__( 'Function %1$s was called <strong>incorrectly</strong>. %2$s %3$s' ),6032				$function_name,6033				$message,6034				$version6035			);6036		} else {6037			if ( $version ) {6038				$version = sprintf( '(This message was added in version %s.)', $version );6039			}6040 6041			$message .= sprintf(6042				' Please see <a href="%s">Debugging in WordPress</a> for more information.',6043				'https://developer.wordpress.org/advanced-administration/debug/debug-wordpress/'6044			);6045 6046			$message = sprintf(6047				'Function %1$s was called <strong>incorrectly</strong>. %2$s %3$s',6048				$function_name,6049				$message,6050				$version6051			);6052		}6053 6054		wp_trigger_error( '', $message );6055	}6056}

History

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.