Regression: get_queried_object no longer working with pre_get_posts and pretty permalinks

[Otto42]

Plugin code to demonstrate the issue:

function test( $query ) {
    if ( ! $query->is_main_query() )
    return;

    if ( $query->is_category('uncategorized') ) {
        var_dump($query->get_queried_object());
        die;
    }
}
add_action( 'pre_get_posts', 'test' );

Now visit /category/uncategorized on a default install with any form of non-default (pretty) permalinks configured.

Result in 3.7, it dumps this object and dies:

object(stdClass)#95 (15) { ["term_id"]=> &string(1) "1" ["name"]=> &string(13) "Uncategorized" ["slug"]=> &string(13) "uncategorized" ["term_group"]=> string(1) "0" ["term_taxonomy_id"]=> string(1) "1" ["taxonomy"]=> string(8) "category" ["description"]=> &string(0) "" ["parent"]=> &string(1) "0" ["count"]=> &string(1) "1" ["cat_ID"]=> &string(1) "1" ["category_count"]=> &string(1) "1" ["category_description"]=> &string(0) "" ["cat_name"]=> &string(13) "Uncategorized" ["category_nicename"]=> &string(13) "uncategorized" ["category_parent"]=> &string(1) "0" }

Result in 3.8: The is_category check returns false and no object is dumped.

Removing the is_category check reveals that the get_queried_object returns NULL.

Note that switching to default (ugly) permalinks restores the expected behavior. Also note that using the ?cat=1 style URL gives the expected behavior even with pretty permalinks enabled.

[Otto42]

Relevant support thread where people had problems because of this:
​http://wordpress.org/support/topic/pre_get_posts-doenst-work-with-pretty-permalinks-anymore

[Otto42]

Issue appears to have been introduced in [26007] for #20767.

[jeremyfelt]

At first glance, tags appear to be safe. Both tag_id and tag are available as query_vars. Confirmed on categories.

[jeremyfelt]

26627.diff​ checks for a valid term after using cat and then makes an attempt with get_term_by() using category_name if it is not found.

[wonderboymusic]

26627.2.diff​ is a different take and expands on my original unit tests - in most cases involving tax_query, the state of query vars is different during pre_get_posts then it is after query has run.

For instance, get_query_var( 'taxonomy' ) and get_query_var( 'term_id' ) contain values, but $query->get( 'taxonomy' ) and $query->get( 'term_id' ) in pre_get_posts do not

[jeremyfelt]

26627.2.diff​ works for me. Tests fail before, pass afterward. Reported issue is clear.

Moving to 3.8.1 for consideration.

[wonderboymusic]

Fixed in [26864].

[nacin]

Re-opening to be code-reviewed and considered for inclusion in 3.8.1.

[layotte]

Submitted patch here #26728 which fixes bug in [26864]

[Otto42]

Related: #26728

[nacin]

[26874] fixes the bug in [26864].

We usually default to reverting changes that result in regressed behavior in a minor release, opting to look forward to fixing the issue in the next major release. This prevents us from digging ourselves into a bigger hole with an additional regression (not unlike like the bug caused by [26864]).

wonderboymusic and SergeyBiryukov, to be clear: For 3.8.1, the recommendation is to merge [26864] and [26874], in lieu of reverting [26007]?

[wonderboymusic]

yes, please

[SergeyBiryukov]

Yes. Working on a unit test for [26874].

[SergeyBiryukov]

Unit test committed in [26875].

[jeremyclarke]

Hit this problem really hard and [26864] solved it for me. Definitely should be in 3.8.1 IMHO.

[nacin]

In 26946:

Query: Fix category handling in pre_get_posts when pretty permalinks are in use (category_name query variable).

Merges [26864] [26874] [26875] to the 3.8 branch.

props wonderboymusic, SergeyBiryukov.
fixes #26627.

[wonderboymusic]

26627.3.diff​ makes get_queried_object() work for tags in pre_get_posts - note, tags do not get rolled up into tax_query, categories do.

[nacin]

This ticket was closed on a completed milestone. I'm re-closing.

[SergeyBiryukov]

Follow-up: #27362