W3cubDocs

/WordPress

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

Mark something as being incorrectly called.

Description

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.

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.

Source

File: 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 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. */
					__( '%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(
					'%1$s was called <strong>incorrectly</strong>. %2$s %3$s',
					$function,
					$message,
					$version
				),
				E_USER_NOTICE
			);
		}
	}
}

Uses

Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/functions.php: doing_it_wrong_run

Fires when the given function is being used incorrectly.
wp-includes/functions.php: doing_it_wrong_trigger_error

Filters whether to trigger an error for _doing_it_wrong() calls.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Used By

Used By Description
wp-includes/class-wp-block-patterns-registry.php: WP_Block_Patterns_Registry::unregister()

Unregisters a pattern.
wp-includes/class-wp-block-patterns-registry.php: WP_Block_Patterns_Registry::register()

Registers a pattern.
wp-includes/class-wp-block-pattern-categories-registry.php: WP_Block_Pattern_Categories_Registry::register()

Registers a pattern category.
wp-includes/class-wp-block-pattern-categories-registry.php: WP_Block_Pattern_Categories_Registry::unregister()

Unregisters a pattern category.
wp-includes/rest-api.php: rest_handle_multi_type_schema()

Handles getting the best type for a multi-type schema.
wp-includes/rest-api.php: rest_stabilize_value()

Stabilizes a value following JSON Schema semantics.
wp-includes/blocks.php: register_block_script_handle()

Finds a script handle for the selected block metadata field. It detects when a path to file was provided and finds a corresponding asset file with details necessary to register the script under automatically generated handle name. It returns unprocessed script handle otherwise.
wp-includes/sitemaps/class-wp-sitemaps-renderer.php: WP_Sitemaps_Renderer::get_sitemap_index_xml()

Gets XML for a sitemap index.
wp-includes/sitemaps/class-wp-sitemaps-renderer.php: WP_Sitemaps_Renderer::get_sitemap_xml()

Gets XML for a sitemap.
wp-includes/query.php: is_favicon()

Is the query for the favicon.ico file?
wp-includes/class-wp-block-styles-registry.php: WP_Block_Styles_Registry::register()

Registers a block style.
wp-includes/class-wp-block-styles-registry.php: WP_Block_Styles_Registry::unregister()

Unregisters a block style.
wp-includes/query.php: is_privacy_policy()

Determines whether the query is for the Privacy Policy page.
wp-includes/ms-site.php: wp_check_site_meta_support_prefilter()

Aborts calls to site meta if it is not supported.
wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php: WP_REST_Search_Controller::__construct()

Constructor.
wp-includes/class-wp-block-type-registry.php: WP_Block_Type_Registry::register()

Registers a block type.
wp-includes/class-wp-block-type-registry.php: WP_Block_Type_Registry::unregister()

Unregisters a block type.
wp-includes/user.php: wp_user_personal_data_exporter()

Finds and exports personal data associated with an email address from the user and user_meta table.
wp-admin/includes/plugin.php: wp_add_privacy_policy_content()

Helper function for adding content to the Privacy Policy Guide.
wp-includes/functions.php: wp_is_uuid()

Validates that a UUID is valid.
wp-includes/rest-api.php: rest_sanitize_value_from_schema()

Sanitize a value based on a schema.
wp-includes/rest-api.php: rest_validate_value_from_schema()

Validate a value based on a schema.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::get_item_schema()

Retrieves the post’s schema, conforming to JSON Schema.
wp-includes/rest-api/endpoints/class-wp-rest-controller.php: WP_REST_Controller::register_routes()

Registers the routes for the objects of the controller.
wp-includes/functions.wp-scripts.php: wp_add_inline_script()

Adds extra code to a registered script.
wp-includes/customize/class-wp-customize-partial.php: WP_Customize_Partial::render()

Renders the template partial involving the associated settings.
wp-includes/rest-api.php: register_rest_route()

Registers a REST API route.
wp-includes/query.php: is_embed()

Is the query for an embedded post?
wp-includes/class-wp-date-query.php: WP_Date_Query::validate_date_values()

Validates the given date_query values and triggers errors if something is not valid.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::remove_panel()

Remove a customize panel.
wp-includes/option.php: register_setting()

Registers a setting and its data.
wp-admin/includes/plugin.php: add_submenu_page()

Add a submenu page.
wp-admin/includes/template.php: convert_to_screen()

Convert a screen string to a screen object
wp-includes/capabilities.php: map_meta_cap()

Maps meta capabilities to primitive capabilities.
wp-includes/theme.php: add_theme_support()

Registers theme support for a given feature.
wp-includes/pluggable.php: check_admin_referer()

Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
wp-includes/pluggable.php: check_ajax_referer()

Verifies the Ajax request to prevent processing requests external of the blog.
wp-includes/query.php: is_preview()

Determines whether the query is for a post or page preview.
wp-includes/query.php: is_robots()

Is the query for the robots.txt file?
wp-includes/query.php: is_search()

Determines whether the query is for a search.
wp-includes/query.php: is_single()

Determines whether the query is for an existing single post.
wp-includes/query.php: is_singular()

Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
wp-includes/query.php: is_time()

Determines whether the query is for a specific time.
wp-includes/query.php: is_trackback()

Determines whether the query is for a trackback endpoint call.
wp-includes/query.php: is_year()

Determines whether the query is for an existing year archive.
wp-includes/query.php: is_404()

Determines whether the query has resulted in a 404 (returns no results).
wp-includes/query.php: is_main_query()

Determines whether the query is the main query.
wp-includes/query.php: is_attachment()

Determines whether the query is for an existing attachment page.
wp-includes/query.php: is_author()

Determines whether the query is for an existing author archive page.
wp-includes/query.php: is_category()

Determines whether the query is for an existing category archive page.
wp-includes/query.php: is_tag()

Determines whether the query is for an existing tag archive page.
wp-includes/query.php: is_date()

Determines whether the query is for an existing date archive.
wp-includes/query.php: is_day()

Determines whether the query is for an existing day archive.
wp-includes/query.php: is_feed()

Determines whether the query is for a feed.
wp-includes/query.php: is_tax()

Determines whether the query is for an existing custom taxonomy archive page.
wp-includes/query.php: is_comment_feed()

Is the query for a comments feed?
wp-includes/query.php: is_front_page()

Determines whether the query is for the front page of the site.
wp-includes/query.php: is_home()

Determines whether the query is for the blog homepage.
wp-includes/query.php: is_month()

Determines whether the query is for an existing month archive.
wp-includes/query.php: is_page()

Determines whether the query is for an existing single page.
wp-includes/query.php: is_paged()

Determines whether the query is for a paged result and not for the first page.
wp-includes/query.php: is_archive()

Determines whether the query is for an existing archive page.
wp-includes/query.php: is_post_type_archive()

Determines whether the query is for an existing post type archive page.
wp-includes/functions.wp-scripts.php: wp_deregister_script()

Remove a registered script.
wp-includes/functions.php: wp_send_json()

Send a JSON response back to an Ajax request.
wp-includes/taxonomy.php: register_taxonomy()

Creates or modifies a taxonomy object.
wp-includes/class-wp-admin-bar.php: WP_Admin_Bar::add_node()

Adds a node to the menu.
wp-includes/functions.wp-styles.php: wp_add_inline_style()

Add extra CSS styles to a registered stylesheet.
wp-includes/shortcodes.php: do_shortcode_tag()

Regular Expression callable for do_shortcode() for calling shortcode hook.
wp-includes/shortcodes.php: add_shortcode()

Adds a new shortcode.
wp-includes/plugin.php: register_uninstall_hook()

Set the uninstallation hook for a plugin.
wp-includes/post.php: wp_insert_post()

Insert or update a post.
wp-includes/post.php: register_post_type()

Registers a post type.
wp-includes/nav-menu.php: register_nav_menus()

Registers navigation menu locations for a theme.
wp-includes/wp-db.php: wpdb::_real_escape()

Real escape, using mysqli_real_escape_string() or mysql_real_escape_string().
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution.
wp-includes/widgets.php: the_widget()

Output an arbitrary widget as a template tag.
wp-includes/widgets.php: register_sidebar()

Builds the definition for a single sidebar and returns the ID.
wp-includes/meta.php: register_meta()

Registers a meta key.

Changelog

Version Description
5.4.0 This function is no longer marked as "private".
3.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_doing_it_wrong