Twenty Nineteen: get_the_archive_title filter issues

[taskotr]

I was testing the theme with a plugin that adds a custom post type and allows to set a custom title for the custom post type archive view using the following filter:

add_filter( 'get_the_archive_title', 'slug_set_the_archive_title' );

While this filter works fine in the previous WordPress themes, such as Twenty Seventeen, Twenty Sixteen and Twenty Fifteen, it does not work in Twenty Nineteen.

It's possible to fix it by setting a priority parameter in the filter. For example:

add_filter( 'get_the_archive_title', 'slug_set_the_archive_title', 99 );

The problem is that it breaks a header style, meaning the title will have the style of the archive view prefix text (grey color and serif font style).

Any idea what is the better way to use this filter in the
Twenty Nineteen theme?

[mukesh27]

@taskotr Theme already used add_filter( 'get_the_archive_title', 'twentynineteen_get_the_archive_title' ); archive filter with priority of 10 so if you want to override that filter with your plugin functionality then you have to add high priority then 10 then your filter works in Twenty Nineteen.

For ex.

If you have develop plugin with below filter then add below priority.

add_filter( 'get_the_archive_title', 'slug_set_the_archive_title', 99 );

If you have use any third party plugin and it's filter does not work then remove theme filter using below code.

remove_filter( 'get_the_archive_title', 'twentynineteen_get_the_archive_title' );

For better solution, In Twenty Nineteen theme we needs to change filter priority to 1 instead of 10 so plugin can override filter as per there needs.

[mukesh27]

Patch to change theme filter priority

[mukesh27]

Attached patch change filter priority to 1 instead of 10 so plugin can override filter as per there needs.

Description
Changes the priority of the get_the_archive_title filter in twentynineteen_get_the_archive_title from 10 to 1. This allows plugins and child themes to override the archive title using the default priority of 10, resolving conflict issues where the theme would forcefully overwrite plugin customizations.

This PR refreshes the initial patch provided by @mukesh27.

I tested the patch and confirmed that everything behaves as expected. The patch just needed a refresh, so I am submitting this PR to update the initial patch.

Tickets: https://core.trac.wordpress.org/ticket/45955

Steps to Reproduce

1. Install and activate the Twenty Nineteen theme.
2. Create and activate a helper plugin (or add to child theme's functions.php) with the following code to override the archive title at the default priority (10):

   <?php
           /**
            * Plugin Name: Test Trac 45955
            */
           
           function trac_test_archive_title( $title ) {
                   return 'TEST PASSED: Plugin Override Successful';
           }
           add_filter( 'get_the_archive_title', 'trac_test_archive_title' );
   

3. Visit any archive page on the frontend (e.g., a Category, Tag, or Author archive).
4. Observe that the page title is NOT changed to "TEST PASSED...". It remains the default theme title (e.g., "Category Archives: ...").

Test Report

1. Apply the patch.
2. Visit the same archive page as above.
3. Observe that the page title IS now changed to "TEST PASSED: Plugin Override Successful".
4. This confirms the theme now allows plugins to override the title at the default priority.

[westonruter]

If this change is applied to Twenty Nineteen, shouldn't it also be applied to Twenty Twenty? It looks like it has the ​same issue.

[huzaifaalmesbah]

Thanks for the suggestion, @westonruter.

I’ve applied the same change to Twenty Twenty as well, since it had the same issue. The update is included in the latest commit on PR please check it out and let me know if everything looks good now.

[sabernhardt]

Changing the priority now would cause a problem in any site that uses ​remove_filter() for these hooks at priority 10.

To remove a hook, the $callback and $priority arguments must match when the hook was added.

Using an earlier priority might have been appropriate before the themes were publicly available, but changing it after more than five years is not good.

Any filters that adjust the themes' output should already use a priority of at least 11, or else the site should remove the default filter at priority 10.
remove_filter( 'get_the_archive_title', 'twentynineteen_get_the_archive_title' );

[westonruter]

Good point. Yeah, this will likely break some sites. Better to just require a higher priority to ensure the filter applies as desired.

Closing per https://core.trac.wordpress.org/ticket/45955#comment:7

Thank you for opening a PR!