How to use admin_email_confirm action in WordPress

admin_email_confirm action

Fires before the admin email confirm form.

To use the admin_email_confirm 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 creating 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 weplugins_execute_on_admin_email_confirm_event which takes 1 parameter, and we registered it using add_action. The first parameter admin_email_confirm is the name of the hook, the second parameter weplugins_execute_on_admin_email_confirm_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 the admin_email_confirm action.

Parameters

Below the 1 parameter is required to use this hook.

• $errors : (WP_Error) A WP_Error object containing any errors generated by using invalid credentials. Note that the error object may not contain any errors.

Live Example

do_action( 'admin_email_confirm', WP_Error $errors )

Below is an example of how you can use this hook.

Example 1: Adding a Custom Function to the Hook

        function weplugins_execute_on_admin_email_confirm_event($errors){
           // You can write code here to be executed when this action occurs in WordPress. Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
        }
        // add the action
        add_action( "admin_email_confirm", "weplugins_execute_on_admin_email_confirm_event" , 10, 1);
    

Example 2: Removing a Hook Callback

remove_action( "admin_email_confirm", "weplugins_execute_on_admin_email_confirm_event", 10, 1 );

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Example 3: Custom Error Handling

        function weplugins_custom_admin_email_confirm_error_handling($errors){
           // Custom error handling code here
           if ( is_wp_error( $errors ) ) {
               // Do something with the errors
           }
        }
        // add the action
        add_action( "admin_email_confirm", "weplugins_custom_admin_email_confirm_error_handling" , 10, 1);
    

Contact Us

If you’re having any trouble using this hook or need customization, please contact us and we’d be happy to assist you.