How to use auto_core_update_email filter in WordPress

auto_core_update_email filter

Filters the email sent following an automatic background core update.

To use the auto_core_update_email filter, first, you have to register it using add_filter. 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 weplugins_modify_auto_core_update_email_defaults which takes 4 parameters and we registered using add_filter. The first parameter auto_core_update_email is the name of the hook, The second parameter weplugins_modify_auto_core_update_email_defaults 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_filter to remove auto_core_update_email filter.

Parameters

Below are the 4 parameters required to use this hook.

• $email : (array) Array of email arguments that will be passed to wp_mail().
  ‘to’ (string) The email recipient. An array of emails can be returned, as handled by wp_mail().
  ‘subject’ (string) The email’s subject.
  ‘body’ (string) The email message body.
  ‘headers’ (string) Any email headers, defaults to no headers.
• $type : (string) The type of email being sent. Can be one of ‘success’, ‘fail’, ‘manual’, ‘critical’.
• $core_update : (object) The update offer that was attempted.
• $result : (mixed) The result for the core update. Can be WP_Error.

Live Example

apply_filters( 'auto_core_update_email', array $email, string $type, object $core_update, mixed $result )

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

Example 1: Modifying the Email Content

In this example, we modify the email content sent after a core update.

    function weplugins_modify_auto_core_update_email_defaults($email, $type, $core_update, $result) { 
        // Update the $email variable according to your website requirements and return this variable.
        $email['body'] .= "nnThis is a custom message added to the email.";
        return $email; 
    }
    // add the filter
    add_filter( "auto_core_update_email", "weplugins_modify_auto_core_update_email_defaults", 10, 4 );
    

Example 2: Changing the Email Subject

In this example, we change the email subject based on the type of update.

    function weplugins_modify_auto_core_update_email_subject($email, $type, $core_update, $result) { 
        if ($type == 'success') {
            $email['subject'] = "Core Update Successful!";
        } else {
            $email['subject'] = "Core Update Notification";
        }
        return $email; 
    }
    // add the filter
    add_filter( "auto_core_update_email", "weplugins_modify_auto_core_update_email_subject", 10, 4 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "auto_core_update_email", "weplugins_modify_auto_core_update_email_defaults", 10, 4 );
    

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

Contact Us

If you need any customization or have trouble using this hook, please contact us.