How to use populate_network_meta filter in WordPress

populate_network_meta filter

Filters meta for a network on creation.

To use populate_network_meta 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_populate_network_meta_defaults which takes 2 parameters and we registered using add_filter. The first parameter populate_network_meta is name of the hook, The second parameter weplugins_modify_populate_network_meta_defaults is name of the function which needs to be called, 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 populate_network_meta filter.

Parameters

Below are the 2 parameters required to use this hook.

• $sitemeta: (array) Associative array of network meta keys and values to be inserted.
• $network_id: (int) ID of network to populate.

Live Example 1

Here’s how you can use this hook:

    function weplugins_modify_populate_network_meta_defaults($sitemeta, $network_id) { 
        // Update the $sitemeta variable according to your website requirements and return this variable. You can modify the $sitemeta variable conditionally too if you want.
        return $sitemeta; 
    }
    // add the filter
    add_filter("populate_network_meta", "weplugins_modify_populate_network_meta_defaults", 10, 2);
    

Live Example 2

To remove a hook callback, use the example below:

    remove_filter("populate_network_meta", "weplugins_modify_populate_network_meta_defaults", 10, 2);
    

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

Live Example 3

Another example of modifying the network meta:

    function weplugins_another_modify_populate_network_meta($sitemeta, $network_id) {
        // Add a new meta key
        $sitemeta['new_key'] = 'new_value';
        return $sitemeta;
    }
    add_filter("populate_network_meta", "weplugins_another_modify_populate_network_meta", 15, 2);