How to use admin_title filter in WordPress

admin_title filter

Filters the title tag content for an admin page.

To use the admin_title filter, you first have to register it using add_filter. You can write this code into the functions.php file 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 live examples below, we have defined a function weplugins_modify_admin_title_defaults which takes 2 parameters and we registered it using add_filter. The first parameter admin_title is the name of the hook, the second parameter weplugins_modify_admin_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 admin_title filter.

Parameters

Below are the 2 parameters required to use this hook.

• $admin_title : (string) The page title, with extra context added.
• $title : (string) The original page title.

Live Example 1: Modifying the Admin Title

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

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

Live Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter("admin_title", "weplugins_modify_admin_title_defaults", 10, 2);
    

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

Live Example 3: Conditional Admin Title Modification

Here’s another example of modifying the admin title based on a condition.

    function weplugins_conditional_admin_title($admin_title, $title) {
        if ($title == 'Dashboard') {
            $admin_title = 'Custom Dashboard Title';
        }
        return $admin_title;
    }
    // Add the filter
    add_filter("admin_title", "weplugins_conditional_admin_title", 10, 2);
    

Contact Us

If you need any customization or are facing any issues using this hook, feel free to Contact Us.