wp_admin_notice()

💡 云策文档标注

概述

wp_admin_notice() 是 WordPress 6.4.0 引入的函数，用于在管理后台输出通知消息。它接受消息字符串和参数数组，支持自定义通知类型、可关闭性等属性。

关键要点

函数 wp_admin_notice( $message, $args = array() ) 输出管理通知，参数 $message 为必需的消息字符串，$args 为可选参数数组。
$args 参数包括 type（如 'error'、'success'）、dismissible（是否可关闭）、id（ID 属性）、additional_classes（额外 CSS 类）、attributes（额外属性）和 paragraph_wrap（是否用段落标签包裹消息）。
函数内部触发 wp_admin_notice 动作钩子，并调用 wp_get_admin_notice() 生成标记，使用 wp_kses_post() 进行安全过滤。
在插件中使用时，建议通过 add_action( 'admin_notices', ... ) 钩子调用 wp_admin_notice()，以避免直接输出错误。

代码示例

add_action( 'admin_notices', function () {
    wp_admin_notice(
        __( 'Your success message here.', 'your-text-domain' ),
        array(
            'id'                 => 'message',
            'additional_classes' => array( 'updated' ),
            'dismissible'        => true,
        )
    );
} );

注意事项

wp_admin_notice() 自 WordPress 6.4.0 版本引入，使用时需确保 WordPress 版本兼容。相关函数包括 wp_get_admin_notice()、wp_kses_post() 和 do_action()。

📄 原文内容

Outputs an admin notice.

Parameters

$messagestringrequired

The message to output.

$argsarrayoptional

An array of arguments for the admin notice.

type string
Optional. The type of admin notice.
For example, 'error', 'success', 'warning', 'info'.
dismissible bool
Optional. Whether the admin notice is dismissible. Default false.
id string
Optional. The value of the admin notice’s ID attribute.
additional_classes string[]
Optional. A string array of class names.
attributes string[]
Optional. Additional attributes for the notice div.
paragraph_wrap bool
Optional. Whether to wrap the message in paragraph tags. Default true.

Default:array()

Source

function wp_admin_notice( $message, $args = array() ) {
	/**
	 * Fires before an admin notice is output.
	 *
	 * @since 6.4.0
	 *
	 * @param string $message The message for the admin notice.
	 * @param array  $args    The arguments for the admin notice.
	 */
	do_action( 'wp_admin_notice', $message, $args );

	echo wp_kses_post( wp_get_admin_notice( $message, $args ) );
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘wp_admin_notice’, string $message, array $args ): Fires before an admin notice is output.

Uses	Description
wp_get_admin_notice()`wp-includes/functions.php`	Creates and returns the markup for an admin notice.
wp_kses_post()`wp-includes/kses.php`	Sanitizes content for allowed HTML tags for post content.
do_action()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook.

Show 1 more Show less

Used by	Description
WP_Plugin_Dependencies::display_admin_notice_for_unmet_dependencies()`wp-includes/class-wp-plugin-dependencies.php`	Displays an admin notice if dependencies are not installed.
WP_Plugin_Dependencies::display_admin_notice_for_circular_dependencies()`wp-includes/class-wp-plugin-dependencies.php`	Displays an admin notice if circular dependencies are installed.
deactivated_plugins_notice()`wp-admin/includes/plugin.php`	Renders an admin notice when a plugin was deactivated during an update.
core_auto_updates_settings()`wp-admin/update-core.php`	Display WordPress auto-updates settings.
WP_MS_Themes_List_Table::column_autoupdates()`wp-admin/includes/class-wp-ms-themes-list-table.php`	Handles the auto-updates column output.
paused_themes_notice()`wp-admin/includes/theme.php`	Renders an admin notice in case some themes have been paused due to errors.
wp_recovery_mode_nag()`wp-admin/includes/update.php`	Displays a notice when the user is in recovery mode.
paused_plugins_notice()`wp-admin/includes/plugin.php`	Renders an admin notice in case some plugins have been paused due to errors.
WP_Privacy_Policy_Content::notice()`wp-admin/includes/class-wp-privacy-policy-content.php`	Adds a notice with a link to the guide when editing the privacy policy page.
WP_Privacy_Policy_Content::policy_text_changed_notice()`wp-admin/includes/class-wp-privacy-policy-content.php`	Outputs a warning when some privacy info has changed.
WP_Widget_Media_Audio::render_control_template_scripts()`wp-includes/widgets/class-wp-widget-media-audio.php`	Render form template scripts.
WP_Widget_Media_Video::render_control_template_scripts()`wp-includes/widgets/class-wp-widget-media-video.php`	Render form template scripts.
WP_Widget_Media_Image::render_control_template_scripts()`wp-includes/widgets/class-wp-widget-media-image.php`	Render form template scripts.
wp_print_community_events_markup()`wp-admin/includes/dashboard.php`	Prints the markup for the Community Events section of the Events and News Dashboard widget.
WP_MS_Themes_List_Table::column_description()`wp-admin/includes/class-wp-ms-themes-list-table.php`	Handles the description column output.
WP_Customize_Theme_Control::content_template()`wp-includes/customize/class-wp-customize-theme-control.php`	Render a JS template for theme display.
login_header()`wp-login.php`	Outputs the login page header.
network_step1()`wp-admin/includes/network.php`	Prints step 1 for Network installation process.
network_step2()`wp-admin/includes/network.php`	Prints step 2 for Network installation process.
WP_Plugins_List_Table::single_row()`wp-admin/includes/class-wp-plugins-list-table.php`
Bulk_Upgrader_Skin::after()`wp-admin/includes/class-bulk-upgrader-skin.php`	Performs an action following a bulk update.
site_admin_notice()`wp-admin/includes/ms.php`	Displays an admin notice to upgrade all sites after a core upgrade.
new_user_email_admin_notice()`wp-includes/user.php`	Adds an admin notice alerting the user to check for confirmation request email after email address change.
maintenance_nag()`wp-admin/includes/update.php`	Displays maintenance nag HTML message.
update_nag()`wp-admin/includes/update.php`	Returns core update notification message.
install_plugin_information()`wp-admin/includes/plugin-install.php`	Displays plugin information in dialog box form.
wp_dashboard_quick_press()`wp-admin/includes/dashboard.php`	Displays the Quick Draft widget.
default_password_nag()`wp-admin/includes/user.php`
WP_Plugin_Install_List_Table::display_rows()`wp-admin/includes/class-wp-plugin-install-list-table.php`	Generates the list table rows.
WP_Plugin_Install_List_Table::no_items()`wp-admin/includes/class-wp-plugin-install-list-table.php`
_local_storage_notice()`wp-admin/includes/template.php`	Outputs the HTML for restoring the post data from DOM storage
wp_comment_reply()`wp-admin/includes/template.php`	Outputs the in-line comment reply-to form in the Comments list table.
wp_import_upload_form()`wp-admin/includes/template.php`	Outputs the form used by the importers to accept the data to be imported.
do_meta_boxes()`wp-admin/includes/template.php`	Meta-Box template function.
post_submit_meta_box()`wp-admin/includes/meta-boxes.php`	Displays post submit form fields.
WP_Terms_List_Table::inline_edit()`wp-admin/includes/class-wp-terms-list-table.php`	Outputs the hidden row displayed when inline editing
request_filesystem_credentials()`wp-admin/includes/file.php`	Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.
WP_Posts_List_Table::inline_edit()`wp-admin/includes/class-wp-posts-list-table.php`	Outputs the hidden row displayed when inline editing
Custom_Image_Header::step_1()`wp-admin/includes/class-custom-image-header.php`	Displays first step of custom header image page.
core_upgrade_preamble()`wp-admin/update-core.php`	Display upgrade WordPress for downloading latest or upgrading automatically form.
Custom_Background::admin_page()`wp-admin/includes/class-custom-background.php`	Displays the custom background page.
WP_Widget_Text::form()`wp-includes/widgets/class-wp-widget-text.php`	Outputs the Text widget settings form.
wp_print_media_templates()`wp-includes/media-template.php`	Prints the templates used in the media manager.

Show 38 more Show less

Changelog

Version	Description
6.4.0	Introduced.

User Contributed Notes

Skip to note 3 content

dcoderoli

2 years ago

In the plugin php file, using wp_admin_notice() throws an error, I just wrap it in the add_action hook

add_action( 'admin_notices', function () {
	wp_admin_notice(
		__( 'Your success message here.', 'your-text-domain' ),
		array(
			'id'                 => 'message',
			'additional_classes' => array( 'updated' ),
			'dismissible'        => true,
		)
	);
} );

Skip to note 4 content

Baikare Sandip

2 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
With this method you can show the message in the WordPress admin.
```
wp_admin_notice(
	__( 'Your success message here.', 'your-text-domain' ),
	array(
		'id'                 => 'message',
		'additional_classes' => array( 'updated' ),
		'dismissible'        => true,
	)
);
```
Log in to add feedback

云策 WordPress 开发者社区

函数文档

wp_admin_notice()

概述

关键要点

代码示例

注意事项

Parameters

Source

Hooks

Changelog

User Contributed Notes

函数文档

概述

关键要点

代码示例

注意事项

Parameters

Source

Hooks

Related

Changelog

User Contributed Notes