WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_trigger_error()

wp_trigger_error( string $function_name, string $message, int $error_level = E_USER_NOTICE )

In this article

Back to top

Generates a user-level error/warning/notice/deprecation message.

Description

Generates the message when WP_DEBUG is true.

Parameters

$function_namestringrequired
The function that triggered the error.
$messagestringrequired
The message explaining the error.
The message can contain allowed HTML 'a' (with href), 'code', 'br', 'em', and 'strong' tags and http or https protocols.
If it contains other HTML tags or protocols, the message should be escaped before passing to this function to avoid being stripped wp_kses().
$error_levelintoptional
The designated error type for this error.
Only works with E_USER family of constants.

Default:E_USER_NOTICE

Source

function wp_trigger_error( $function_name, $message, $error_level = E_USER_NOTICE ) {	// Bail out if WP_DEBUG is not turned on.	if ( ! WP_DEBUG ) {	return;	}	/** * Fires when the given function triggers a user-level error/warning/notice/deprecation message. * * Can be used for debug backtracking. * * @since 6.4.0 * * @param string $function_name The function that was called. * @param string $message A message explaining what has been done incorrectly. * @param int $error_level The designated error type for this error. */	do_action( 'wp_trigger_error_run', $function_name, $message, $error_level );	if ( ! empty( $function_name ) ) {	$message = sprintf( '%s(): %s', $function_name, $message );	}	$message = wp_kses(	$message,	array(	'a' => array( 'href' => true ),	'br' => array(),	'code' => array(),	'em' => array(),	'strong' => array(),	),	array( 'http', 'https' )	);	if ( E_USER_ERROR === $error_level ) {	throw new WP_Exception( $message );	}	trigger_error( $message, $error_level ); }

View all references View on Trac View on GitHub

Hooks

do_action( ‘wp_trigger_error_run’, string $function_name, string $message, int $error_level )

Fires when the given function triggers a user-level error/warning/notice/deprecation message.

UsesDescription
wp_kses()wp-includes/kses.php

Filters text content and strips out disallowed HTML.

do_action()wp-includes/plugin.php

Calls the callback functions that have been added to an action hook.

Used byDescription
wp_unique_prefixed_id()wp-includes/functions.php

Generates an incremental ID that is independent per each different prefix.

_deprecated_class()wp-includes/functions.php

Marks a class as deprecated and informs when it has been used.

_wp_delete_all_temp_backups()wp-includes/update.php

Deletes all contents in the temporary backup directory.

wp_opcache_invalidate_directory()wp-admin/includes/file.php

Attempts to clear the opcode cache for a directory of files.

WP_Theme_JSON_Resolver::get_user_data()wp-includes/class-wp-theme-json-resolver.php

Returns the user’s origin config.

wp_json_file_decode()wp-includes/functions.php

Reads and decodes a JSON file.

_filter_block_template_part_area()wp-includes/block-template-utils.php

Checks whether the input ‘area’ is a supported value.

clean_dirsize_cache()wp-includes/functions.php

Cleans directory size cache used by recurse_dirsize() .

_deprecated_hook()wp-includes/functions.php

Marks a deprecated action or filter hook as deprecated and throws a notice.

_deprecated_constructor()wp-includes/functions.php

Marks a constructor as deprecated and informs when it has been used.

MagpieRSS::__construct()wp-includes/rss.php

PHP5 constructor.

WP_Text_Diff_Renderer_Table::__unset()wp-includes/class-wp-text-diff-renderer-table.php

Make private properties un-settable for backward compatibility.

WP_Text_Diff_Renderer_Table::__get()wp-includes/class-wp-text-diff-renderer-table.php

Make private properties readable for backward compatibility.

WP_Text_Diff_Renderer_Table::__set()wp-includes/class-wp-text-diff-renderer-table.php

Make private properties settable for backward compatibility.

WP_Text_Diff_Renderer_Table::__isset()wp-includes/class-wp-text-diff-renderer-table.php

Make private properties checkable for backward compatibility.

WP_User_Query::__get()wp-includes/class-wp-user-query.php

Makes private properties readable for backward compatibility.

WP_User_Query::__set()wp-includes/class-wp-user-query.php

Makes private properties settable for backward compatibility.

WP_User_Query::__isset()wp-includes/class-wp-user-query.php

Makes private properties checkable for backward compatibility.

WP_User_Query::__unset()wp-includes/class-wp-user-query.php

Makes private properties un-settable for backward compatibility.

WP_List_Table::__get()wp-admin/includes/class-wp-list-table.php

Makes private properties readable for backward compatibility.

WP_List_Table::__set()wp-admin/includes/class-wp-list-table.php

Makes private properties settable for backward compatibility.

WP_List_Table::__isset()wp-admin/includes/class-wp-list-table.php

Makes private properties checkable for backward compatibility.

WP_List_Table::__unset()wp-admin/includes/class-wp-list-table.php

Makes private properties un-settable for backward compatibility.

translations_api()wp-admin/includes/translation-install.php

Retrieve translations from WordPress Translation API.

WP_Upgrader::maintenance_mode()wp-admin/includes/class-wp-upgrader.php

Toggles maintenance mode for the site.

themes_api()wp-admin/includes/theme.php

Retrieves theme installer pages from the WordPress.org Themes API.

get_core_checksums()wp-admin/includes/update.php

Gets and caches the checksums for the given version of WordPress.

plugins_api()wp-admin/includes/plugin-install.php

Retrieves plugin installer pages from the WordPress.org Plugins API.

search_theme_directories()wp-includes/theme.php

Searches all registered theme directories for complete and valid themes.

wp_strip_all_tags()wp-includes/formatting.php

Properly strips all HTML tags including ‘script’ and ‘style’.

_deprecated_function()wp-includes/functions.php

Marks a function as deprecated and inform when it has been used.

_deprecated_file()wp-includes/functions.php

Marks a file as deprecated and inform when it has been used.

_doing_it_wrong()wp-includes/functions.php

Marks something as being incorrectly called.

_deprecated_argument()wp-includes/functions.php

Marks a function argument as deprecated and inform when it has been used.

wp_version_check()wp-includes/update.php

Checks WordPress version against the newest version.

wp_update_plugins()wp-includes/update.php

Checks for available updates to plugins based on the latest versions hosted on WordPress.org.

wp_update_themes()wp-includes/update.php

Checks for available updates to themes based on the latest versions hosted on WordPress.org.

prep_atom_text_construct()wp-includes/feed.php

Determines the type of a string of data with the data formatted.

RSSCache::error()wp-includes/rss.php
MagpieRSS::error()wp-includes/rss.php
ms_subdomain_constants()wp-includes/ms-default-constants.php

Defines Multisite subdomain constants and handles warnings and notices.

Show 36 moreShow less

Changelog

VersionDescription
6.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.