How to use document_title_separator filter in WordPress

document_title_separator filter

Filters the separator for the document title.

To use the `document_title_separator` 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.

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_modify_document_title_separator_defaults` which takes 1 parameter and we registered using `add_filter`. The first parameter `document_title_separator` is the name of the hook, the second parameter `weplugins_modify_document_title_separator_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 `document_title_separator` filter.

Parameters

Below the 1 parameter is required to use this hook.

• $sep : (string) Document title separator. Default ‘-‘.

Live Example 1

Below is an example of how you can use this hook to modify the document title separator.

  function weplugins_modify_document_title_separator_defaults($sep) {
      // Update the $sep variable according to your website requirements and return this variable.
      return '|';
  }
  // add the filter
  add_filter("document_title_separator", "weplugins_modify_document_title_separator_defaults", 10, 1);
  

Live Example 2

Another example where the separator is changed only for specific conditions.

  function weplugins_conditional_document_title_separator($sep) {
      if (is_home()) {
          $sep = '>>';
      }
      return $sep;
  }
  // add the filter
  add_filter("document_title_separator", "weplugins_conditional_document_title_separator", 10, 1);
  

Live Example 3

To remove a hook callback, use the example below.

  function weplugins_modify_document_title_separator_defaults($sep) {
      return '|';
  }
  // add the filter
  add_filter("document_title_separator", "weplugins_modify_document_title_separator_defaults", 10, 1);

  // remove the filter
  remove_filter("document_title_separator", "weplugins_modify_document_title_separator_defaults", 10, 1);
  

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

Contact Us

If you need any customization or are having trouble using this hook, please contact us and we’d be happy to assist you.