This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.
recovery_mode_email filter
Filters the contents of the Recovery Mode email.
To use the recovery_mode_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 modify_recovery_mode_email_defaults which takes 2 parameters and we registered using add_filter. The first parameter recovery_mode_email is the name of the hook, The second parameter modify_recovery_mode_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 the recovery_mode_email filter.
Parameters
Below are the 2 parameters required to use this hook.
- $email : (array) Used to build a call to wp_mail().
- ‘to’ (string|array) Array or comma-separated list of email addresses to send the message.
- ‘subject’ (string) Email subject.
- ‘message’ (string) Message contents.
- ‘headers’ (string|array) Optional. Additional headers.
- ‘attachments’ (string|array) Optional. Files to attach.
- $url : (string) URL to enter recovery mode.
Live Example
Example 1: Basic Email Filter
In this example, we’ll change the recipient of the recovery mode email to ‘admin@example.com’.
add_filter( 'recovery_mode_email', function( $email ) { $email['to'] = 'admin@example.com'; return $email; } );
Example 2: Modify Email Content
Here, we show how you can modify the $email variable according to your website requirements.
function weplugins_modify_recovery_mode_email_defaults($email, $url) { // 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( 'recovery_mode_email', 'weplugins_modify_recovery_mode_email_defaults', 10, 2 );
Example 3: Removing the Hook
To remove a hook callback, use the example below.
remove_filter( 'recovery_mode_email', 'weplugins_modify_recovery_mode_email_defaults', 10, 2 );
Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.
Contact Us
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.