How to use date_formats filter in WordPress

date_formats filter

Filters the default date formats.

To use the date_formats filter, first you have to register it using add_filter. 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 modify_date_formats_defaults which takes 1 parameter and we registered it using add_filter. The first parameter date_formats is the name of the hook, the second parameter modify_date_formats_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_formats filter.

Parameters

Below the 1 parameter is required to use this hook.

• $default_date_formats: (string[]) Array of default date formats.

Live Example

apply_filters('date_formats', string[] $default_date_formats)

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

Example 1

Customizing the default date formats to suit your requirements.

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

Example 2

Adding a new custom date format to the default formats array.

  function weplugins_add_custom_date_format($default_date_formats) { 
      $default_date_formats[] = 'Y-m-d H:i:s'; // Adding a custom date format
      return $default_date_formats; 
  }
  // add the filter
  add_filter("date_formats", "weplugins_add_custom_date_format", 10, 1);
  

Example 3

Removing a hook callback for the date_formats filter.

  function weplugins_remove_date_formats_callback() {
      remove_filter("date_formats", "weplugins_modify_date_formats_defaults", 10, 1);
  }
  add_action('init', 'weplugins_remove_date_formats_callback');
  

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

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.