Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use auto_plugin_theme_update_email filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 12, 2022
5 minutes read
Share Via:

auto_plugin_theme_update_email filter

Filters the email sent following an automatic background update for plugins and themes.

To use auto_plugin_theme_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 Flipper Code, 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 modify_auto_plugin_theme_update_email_defaults which takes 4 parameters and we registered using add_filter. The first parameter auto_plugin_theme_update_email is name of the hook, The second parameter modify_auto_plugin_theme_update_email_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove auto_plugin_theme_update_email filter.

Parameters

    Below are the 4 parameters are 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’, ‘mixed’.
  • $successful_updates : (array) A list of updates that succeeded.
  • $failed_updates : (array) A list of updates that failed.

Live Example

apply_filters( 'auto_plugin_theme_update_email', array $email, string $type, array $successful_updates, array $failed_updates )

Below is an example how you can use this hook.

                        function modify_auto_plugin_theme_update_email_defaults($email, $type, $successful_updates, $failed_updates) { 
   
                            // Update the $email variable according to your website requirements and return this variable. You can modify the $email variable conditionally too if you want.

                            return $email; 
                        }
                        // add the filter
                        add_filter( "auto_plugin_theme_update_email", "modify_auto_plugin_theme_update_email_defaults", 10, 4 );

To remove a hook callback, use the example below.

remove_filter( "auto_plugin_theme_update_email", "modify_auto_plugin_theme_update_email_defaults", 10, 4 );

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.