How to use pre_get_networks action in WordPress

pre_get_networks action

Fires before networks are retrieved.

To use pre_get_networks action, first you have to register it using add_action. 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 execute_on_pre_get_networks_event which takes 1 parameter and we registered it using add_action. The first parameter pre_get_networks is the name of the hook, the second parameter execute_on_pre_get_networks_event 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_action to remove pre_get_networks action.

Parameters

Below the 1 parameter is required to use this hook.

• $query: (WP_Network_Query) Current instance of WP_Network_Query (passed by reference).

Live Example 1: Adding a Custom Action

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

    function weplugins_execute_on_pre_get_networks_event($query) {
        // Custom code to be executed when this action occurs.
    }
    // Add the action
    add_action("pre_get_networks", "weplugins_execute_on_pre_get_networks_event", 10, 1);
    

Live Example 2: Modifying Query Parameters

This example demonstrates modifying query parameters before networks are retrieved.

    function weplugins_modify_network_query($query) {
        // Modify the query parameters as needed
        $query->query_vars['number'] = 5; // Limit the number of networks retrieved
    }
    add_action("pre_get_networks", "weplugins_modify_network_query", 10, 1);
    

Live Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    // Remove the action
    remove_action("pre_get_networks", "weplugins_execute_on_pre_get_networks_event", 10, 1);
    

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