WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_admin_notice()

wp_admin_notice( string $message, array $args = array() )

In this article

Back to top

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'.
    Default empty string.
  • dismissible bool
    Optional. Whether the admin notice is dismissible. Default false.
  • id string
    Optional. The value of the admin notice’s ID attribute. Default empty string.
  • 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.

UsesDescription
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 moreShow less
Used byDescription
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 moreShow less

Changelog

VersionDescription
6.4.0Introduced.

User Contributed Notes

  1. Skip to note 3 content
    dcoderoli
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    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,
		)
	);
} );

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