How to use document_title_parts filter in WordPress

document_title_parts filter

Filters the parts of the document title.

To use the document_title_parts 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_document_title_parts_defaults` which takes 1 parameter and we registered it using add_filter. The first parameter `document_title_parts` is the name of the hook, the second parameter `modify_document_title_parts_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_parts filter.

Parameters

Below the 1 parameter is required to use this hook.

• $title : (array) The document title parts.
  ‘title’ (string) Title of the viewed page.
  ‘page’ (string) Optional. Page number if paginated.
  ‘tagline’ (string) Optional. Site description when on the home page.
  ‘site’ (string) Optional. Site title when not on the home page.

Live Example 1: Basic Usage

This example demonstrates how to use the document_title_parts filter to modify the document title parts.

    function weplugins_modify_document_title_parts_defaults($title) { 
        // Update the $title variable according to your website requirements and return this variable.
        $title['title'] = 'Custom Title';
        return $title; 
    }
    // add the filter
    add_filter( "document_title_parts", "weplugins_modify_document_title_parts_defaults", 10, 1 );
    

Live Example 2: Conditional Modification

In this example, the document title parts are modified conditionally based on the page type.

    function weplugins_modify_document_title_parts_conditionally($title) { 
        if (is_home()) {
            $title['title'] = 'Welcome to Our Home Page';
        } else {
            $title['title'] = 'Explore Our Site';
        }
        return $title; 
    }
    // add the filter
    add_filter( "document_title_parts", "weplugins_modify_document_title_parts_conditionally", 10, 1 );
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    // Remove the filter
    remove_filter( "document_title_parts", "weplugins_modify_document_title_parts_defaults", 10, 1 );
    

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

Need customization? Contact Us for expert assistance.