How to use parse_term_query action in WordPress

parse_term_query action

Fires after term query vars have been parsed. To use parse_term_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 execute_on_parse_term_query_event which takes 1 parameter, and we registered it using add_action. The first parameter parse_term_query is the name of the hook, the second parameter execute_on_parse_term_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_term_query action.

Parameters

Below the 1 parameter is required to use this hook.

• $query: (WP_Term_Query) Current instance of WP_Term_Query.

Example 1: Basic Hook Usage

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

    function weplugins_execute_on_parse_term_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_term_query", "weplugins_execute_on_parse_term_query_event" , 10, 1);
    

Example 2: Removing Hook Callback

To remove a hook callback, use the example below.

remove_action( "parse_term_query", "weplugins_execute_on_parse_term_query_event", 10, 1 );

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

Example 3: Advanced Hook Usage

For more advanced usage, you might want to modify the query based on certain conditions. Here’s how you can do that:

    function weplugins_advanced_parse_term_query($query){
        if (is_admin() && $query->query_vars['taxonomy'] == 'category') {
            // Custom logic for category taxonomy in admin
            $query->query_vars['orderby'] = 'name';
        }
    }
    add_action('parse_term_query', 'weplugins_advanced_parse_term_query', 10, 1);
    

Contact Us

If you’re having any trouble using this hook or need customizations, please Contact Us and we’d be happy to assist you.