How to use get_the_archive_title filter in WordPress

get_the_archive_title filter

Filters the archive title.

To use get_the_archive_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 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_get_the_archive_title_defaults which takes 3 parameters and is registered using add_filter. The first parameter get_the_archive_title is the name of the hook, the second parameter 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 get_the_archive_title filter.

Parameters

Below are the 3 parameters required to use this hook.

• $title: (string) Archive title to be displayed.
• $original_title: (string) Archive title without prefix.
• $prefix: (string) Archive title prefix.

Example 1: Basic Usage

Here’s a basic example of how you can use this hook.

    function weplugins_modify_get_the_archive_title_defaults($title, $original_title, $prefix) {
        // 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( "get_the_archive_title", "weplugins_modify_get_the_archive_title_defaults", 10, 3 );
    

Example 2: Removing a Hook

To remove a hook callback, use the example below.

    remove_filter( "get_the_archive_title", "weplugins_modify_get_the_archive_title_defaults", 10, 3 );
    

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

Example 3: Custom Archive Title

Below is an example of customizing the archive title based on different archive types.

    function weplugins_custom_archive_title( $title ) {
        if ( is_category() ) {
            $title = single_cat_title( '', false );
        } elseif ( is_tag() ) {
            $title = single_tag_title( '', false );
        } elseif ( is_author() ) {
            $title = '<span class="vcard">' . get_the_author() . '</span>';
        } elseif ( is_post_type_archive() ) {
            $title = post_type_archive_title( '', false );
        } elseif ( is_tax() ) {
            // Custom taxonomy title logic
        }
        return $title;
    }
    add_filter( "get_the_archive_title", "weplugins_custom_archive_title" );
    

Contact Us

If you’re having any trouble using this hook or need customization, please contact our WordPress Development Team and we’d be happy to assist you.