How to use document_title filter in WordPress

document_title filter

Filters the document title.

To use document_title 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 weplugins_modify_document_title_defaults which takes one parameter and we registered using add_filter. The first parameter document_title is the name of the hook, the second parameter weplugins_modify_document_title_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 filter.

Parameters

Below the one parameter is required to use this hook.

• $title : (string) Document title.

Live Example

Example 1: Basic Usage

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

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

Example 2: Conditional Title Modification

Modify the document title based on a specific condition.

function weplugins_modify_document_title_conditionally($title) { 
    if (is_home()) {
        $title = "Welcome to Our Home Page!";
    }
    return $title; 
}
// Add the filter
add_filter("document_title", "weplugins_modify_document_title_conditionally", 10, 1);

Example 3: Removing the Filter

To remove a hook callback, use the example below.

remove_filter("document_title", "weplugins_modify_document_title_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’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.