Tickets:

• Update tests and documentation for Term::posts() #1931
• 2203/post terms api #2208
• 2203/post terms api #2208 (review)

Issue

I almost forgot again about what we discussed in the linked Tickets above.

Solution

This pull request updates the function signature for Term::posts() to use the same pattern that we use for a lot of other functions.

// Old
function posts( $numberposts_or_args = 10, $post_type_or_class = 'any', $post_class = '' );

// New
function posts( $query_args = [] );

Impact

There’s no backwards compatibility, but I added checks when the wrong parameters are passed.

Because I changed the Term::posts() function, I had to update the Term::get_post() function as well. This will trigger a doing-it-wrong notice now. Because we can no longer support the former arguments, this is not a formal deprecation anymore.

Usage Changes

Old usage

In PHP:

$genre->posts( -1, 'book' );

And in Twig:

{% for book in genre.posts(-1, 'book) %}

New usage

In PHP:

$genre->posts( [
    'post_type'     => 'book',
    'post_per_page' => -1,
    'orderby'       => 'menu_order'
] );

And in Twig:

{% for book in genre.posts({
    post_type: 'book',
    posts_per_page: -1,
    orderby: 'menu_order'
}) %}

Considerations

None.

Testing

There are tests that are still failing because of the class parameter that is not supported anymore. We should probably wait until the post factory is finished and update the tests then.