How to use network_admin_email_change_email filter in WordPress

network_admin_email_change_email filter

Filters the contents of the email notification sent when the network admin email address is changed.

To use network_admin_email_change_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.

At WePlugins, we 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_network_admin_email_change_email_defaults which takes 4 parameters and we registered using add_filter. The first parameter network_admin_email_change_email is the name of the hook, the second parameter weplugins_modify_network_admin_email_change_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 network_admin_email_change_email filter.

Parameters

Below are the 4 parameters required to use this hook:

• $email_change_email: (array) Used to build wp_mail().
  • ‘to’: (string) The intended recipient.
  • ‘subject’: (string) The subject of the email.
  • ‘message’: (string) The content of the email. The following strings have a special meaning and will get replaced dynamically:
    • ###OLD_EMAIL###: The old network admin email address.
    • ###NEW_EMAIL###: The new network admin email address.
    • ###SITENAME###: The name of the network.
    • ###SITEURL###: The URL to the site.
  • ‘headers’: (string) Headers.
• $old_email: (string) The old network admin email address.
• $new_email: (string) The new network admin email address.
• $network_id: (int) ID of the network.

Live Examples

Example 1: Basic Usage

Below is an example of how you can use this hook to modify the email content:

    function weplugins_modify_network_admin_email_change_email_defaults($email_change_email, $old_email, $new_email, $network_id) { 
        // Update the $email_change_email variable according to your website requirements and return this variable. You can modify the $email_change_email variable conditionally too if you want.
        return $email_change_email; 
    }
    // add the filter
    add_filter( "network_admin_email_change_email", "weplugins_modify_network_admin_email_change_email_defaults", 10, 4 );
    

Example 2: Customizing the Subject

This example customizes the subject of the email notification:

    function weplugins_modify_network_admin_email_subject($email_change_email, $old_email, $new_email, $network_id) { 
        $email_change_email['subject'] = 'New Network Admin Email Address';
        return $email_change_email; 
    }
    // add the filter
    add_filter( "network_admin_email_change_email", "weplugins_modify_network_admin_email_subject", 10, 4 );
    

Example 3: Adding Headers

Here’s how you can add custom headers to the email notification:

    function weplugins_add_custom_headers($email_change_email, $old_email, $new_email, $network_id) { 
        $email_change_email['headers'] = 'From: My Network <no-reply@my-network.com>';
        return $email_change_email; 
    }
    // add the filter
    add_filter( "network_admin_email_change_email", "weplugins_add_custom_headers", 10, 4 );
    

Removing the Hook

To remove a hook callback, use the example below:

    remove_filter( "network_admin_email_change_email", "weplugins_modify_network_admin_email_change_email_defaults", 10, 4 );
    

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