How to use admin_notices action in WordPress

admin_notices action

Prints admin screen notices.

To use admin_notices action, first you have to register it using add_action. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function execute_on_admin_notices_event and we registered using add_action. The first parameter admin_notices is the name of the hook, the second parameter execute_on_admin_notices_event is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_action to remove admin_notices action.

Parameters

• No parameters

Live Example 1: Display a Success Notice

This example demonstrates how to display a success notice in the admin area.

    function weplugins_sample_admin_notice__success() {
        ?>
        <div class="notice notice-success is-dismissible">
            <p><?php _e( 'Done!', 'sample-text-domain' ); ?></p>
        </div>
        <?php
    }
    add_action( 'admin_notices', 'weplugins_sample_admin_notice__success' );
    &#91;/php&#93;

    <h2>Live Example 2: Execute Custom Code on Admin Notices Event</h2>
    <p>Below is an example of how you can use this hook to execute custom code when the admin notices event occurs.</p>
    
    function weplugins_execute_on_admin_notices_event(){
        // You can write code here to be executed when this action occurs in WordPress website according to your requirements.
    }
    // Add the action
    add_action( "admin_notices", "weplugins_execute_on_admin_notices_event");
    

Live Example 3: Remove a Hook Callback

To remove a hook callback, use the example below. Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

    remove_action( "admin_notices", "weplugins_execute_on_admin_notices_event");
    

Contact Us

If you need any customization or assistance with this hook, feel free to contact us.