How to use pre_get_sites action in WordPress

pre_get_sites action

Fires before sites are retrieved.

To use pre_get_sites 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_sites_event which takes 1 parameter and we registered using add_action. The first parameter pre_get_sites is the name of the hook, the second parameter execute_on_pre_get_sites_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_sites action.

Parameters

Below the 1 parameter is required to use this hook.

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

Live Example 1

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

    function weplugins_execute_on_pre_get_sites_event($query){
       // Code to be executed when this action occurs in WordPress.
    }
    // Add the action
    add_action( "pre_get_sites", "weplugins_execute_on_pre_get_sites_event" , 10, 1);
    

Live Example 2

To remove a hook callback, use the example below.

    remove_action( "pre_get_sites", "weplugins_execute_on_pre_get_sites_event", 10, 1 );
    

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

Live Example 3

Another use case could be modifying the query parameters before sites are retrieved.

    function weplugins_modify_site_query($query){
       // Modify the query parameters
       $query->set('number', 5); // Example: limit to 5 sites
    }
    // Add the action
    add_action( "pre_get_sites", "weplugins_modify_site_query" , 10, 1);
    

Contact Us

If you need any customization or help with this hook, please contact us.