How to use new_site_email filter in WordPress

new_site_email filter

Content should be formatted for transmission via wp_mail().

To use `new_site_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_new_site_email_defaults` which takes 3 parameters and we registered using `add_filter`. The first parameter `new_site_email` is the name of the hook, the second parameter `weplugins_modify_new_site_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 `new_site_email` filter.

Parameters

Below are the 3 parameters required to use this hook.

• $new_site_email : (array) Used to build wp_mail().
  ‘to’
  (string) The email address of the recipient.
  ‘subject’
  (string) The subject of the email.
  ‘message’
  (string) The content of the email.
  ‘headers’
  (string) Headers.
• $site : (WP_Site) Site object of the new site.
• $user : (WP_User) User object of the administrator of the new site.

Live Example

apply_filters( 'new_site_email', array $new_site_email, WP_Site $site, WP_User $user )

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

Example 1: Modifying the New Site Email

This example shows how to modify the default new site email content.

    function weplugins_modify_new_site_email_defaults($new_site_email, $site, $user) { 
        // Update the $new_site_email variable according to your website requirements and return this variable. You can modify the $new_site_email variable conditionally too if you want.
        return $new_site_email; 
    }
    // add the filter
    add_filter( "new_site_email", "weplugins_modify_new_site_email_defaults", 10, 3 );
    

Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "new_site_email", "weplugins_modify_new_site_email_defaults", 10, 3 );
    

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

Example 3: Customizing Email Headers

This example customizes the headers of the new site email.

    function weplugins_customize_new_site_email_headers($new_site_email, $site, $user) { 
        $new_site_email['headers'] = 'From: Your Name <yourname@example.com>';
        return $new_site_email; 
    }
    // add the filter
    add_filter( "new_site_email", "weplugins_customize_new_site_email_headers", 10, 3 );