How to use parse_site_query action in WordPress

parse_site_query action

Fires after the site query vars have been parsed.

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

Parameters

Below the 1 parameter is required to use this hook.

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

Live Example

do_action_ref_array('parse_site_query', WP_Site_Query $query)

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

    function weplugins_execute_on_parse_site_query_event($query) {
        // You can write code here to be executed when this action occurs in WordPress.
        // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // Add the action
    add_action("parse_site_query", "weplugins_execute_on_parse_site_query_event", 10, 1);
    

Remove a Hook Callback

To remove a hook callback, use the example below.

remove_action("parse_site_query", "weplugins_execute_on_parse_site_query_event", 10, 1);

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