How to use date_query_valid_columns filter in WordPress

date_query_valid_columns filter

Filters the list of valid date query columns.

To use the date_query_valid_columns filter, first you have to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin. As a best practice, we always prefer to create a custom WordPress Plugin while using hooks to ensure that nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_date_query_valid_columns_defaults which takes one parameter and we registered using add_filter. The first parameter date_query_valid_columns is the name of the hook, the second parameter weplugins_modify_date_query_valid_columns_defaults 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_filter to remove the date_query_valid_columns filter.

Parameters

Below the 1 parameter is required to use this hook.

• $valid_columns: (string[]) An array of valid date query columns. Defaults are ‘post_date’, ‘post_date_gmt’, ‘post_modified’, ‘post_modified_gmt’, ‘comment_date’, ‘comment_date_gmt’, ‘user_registered’, ‘registered’, ‘last_updated’.

Example 1: Basic Use

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

    function weplugins_modify_date_query_valid_columns_defaults($valid_columns) { 
        // Update the $valid_columns variable according to your website requirements and return this variable. 
        // You can modify the $valid_columns variable conditionally too if you want.
        return $valid_columns; 
    }
    // add the filter
    add_filter( "date_query_valid_columns", "weplugins_modify_date_query_valid_columns_defaults", 10, 1 );
    

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "date_query_valid_columns", "weplugins_modify_date_query_valid_columns_defaults", 10, 1 );
    

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

Example 3: Conditional Modification

Here’s how you can conditionally modify the valid columns based on certain criteria.

    function weplugins_conditional_date_query_modification($valid_columns) {
        if ( /* some condition */ ) {
            // Modify $valid_columns
        }
        return $valid_columns;
    }
    add_filter( "date_query_valid_columns", "weplugins_conditional_date_query_modification", 10, 1 );
    

Contact Us

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