Unsupported `count` argument in `WP_Term_Query` DocBlock

[Tyrannous]

The DocBlock of WP_Term_Query::__construct mentions the count argument:

count bool
Whether to return a term count. If true, will take precedence over $fields. Default false.
–​https://developer.wordpress.org/reference/classes/WP_Term_Query/__construct/

However, this argument is not used in \WP_Term_Query::get_terms, so it should either be removed from the DocBlock or support should be added.

The erroneous DocBlock element has been in core since WordPress 4.6, when WP_Term_Query was introduced in #35381. There, @flixos90 proposed the first iteration of WP_Term_Query in attachment:35381.diff:ticket:35381​, which included support for it (lines 347–351). However, when revising the approach in attachment:35381.2.diff:ticket:35381​, @boonebgorges kept DocBlock but didn't take over the actual code. This went unnoticed and landed in core.

Note that other WP_*_Query classes indeed support a count argument, so while removing it from the DocBlock would be a quick win, it would probably make more sense to actually add support for it.

## Ticket
https://core.trac.wordpress.org/ticket/61094

## Description

• This PR, which involves removing the unsupported count argument from the DocBlock of the WP_Term_Query::__construct method.
• Currently, the DocBlock mentions the count argument, but it is not utilized in the WP_Term_Query::get_terms method. This leads to potential confusion for developers.

## Changes Made

• Removed the count argument description from the WP_Term_Query::__construct method's DocBlock.

## Context
The WP_Term_Query class provides methods for querying terms in WordPress. The count argument was initially proposed but later removed from the code, while the DocBlock remained unchanged. This PR aligns the DocBlock with the actual code behaviour, ensuring clarity and consistency in the documentation.

## Testing

• [ ] Verified that the count argument description is removed from the WP_Term_Query::__construct DocBlock.
• [ ] Tested the functionality of the WP_Term_Query class to ensure no regressions occurred.
• [ ] Reviewed and verified the changes locally.

[Tyrannous]

Hi @swissspidy, the attached PR (apparently AI-generated) removes the count DocBlock parameter.
However, as I wrote in the ticket description, wouldn't it make more sense to add support for it to achieve feature parity with other WP_*_Query classes?

Thanks!

Hi @snehapatil2001, the PR removes the count DocBlock parameter.
However, as I wrote in the Trac ticket description, wouldn't it make more sense to add support for it to achieve feature parity with other WP_*_Query classes?

Thanks!

[SergeyBiryukov]

Hi there, thanks for the ticket!

Replying to Tyrannous:

However, as I wrote in the ticket description, wouldn't it make more sense to add support for it to achieve feature parity with other WP_*_Query classes?

Indeed, I think that would be the preferred solution here.

wouldn't it make more sense to add support for it to achieve feature parity with other WP_*_Query classes?

Isn't that what $fields['count'] is for?

​https://github.com/WordPress/wordpress-develop/blob/4c2efa2d60e4481186b8218883cc77799205584d/src/wp-includes/class-wp-term-query.php#L315-L324

Also, if we're removing the doc block, we should also remove from query_var_defaults:

​https://github.com/WordPress/wordpress-develop/blob/4c2efa2d60e4481186b8218883cc77799205584d/src/wp-includes/class-wp-term-query.php#L209

[peterwilsoncc]

I agree adding support for count would be appropriate for the query class. I think a follow up ticket can be created for that as an enhancement.

For the purposes of WordPress 6.7 (which is no longer accepting enhancements) I think removing the documentation is the best fix.

[peterwilsoncc]

In 59261:

Taxonomy: Remove count argument from WP_Term_Query docs.

The DocBlock of WP_Term_Query::__construct mentions the count argument, however, this argument is not supported in WP_Term_Query::get_terms().

Props sergeybiryukov, swissspidy, snehapatil02, tyrannous.
Fixes #61094.

Merged r59261 / ​https://github.com/WordPress/wordpress-develop/commit/9de0f746551b379f0a1bf96b805dca17566bcfa6

[johnbillion]

This is still referenced in two other docs and included as a default value for the args.

[peterwilsoncc]

In 59325:

Taxonomy: Remove count references from WP_Term_Query.

Remove further documentation and a code reference to the unsupported count argument within WP_Term_Query.

Follow up to [59261].

Props johnbillion.
Fixes #61094

Merged r59325 / ​https://github.com/WordPress/wordpress-develop/commit/d1e0c0f9c6ec966e81dcc2a6062de6a3500c32ee

[peterwilsoncc]

Reopening for backport consideration of r59325 to the 6.7 branch upon sign off by a second committer.

[desrosj]

In 59350:

Taxonomy: Remove count references from WP_Term_Query.

Remove further documentation and a code reference to the unsupported count argument within WP_Term_Query.

Follow up to [59261].

Reviewed by peterwilsoncc, desrosj.
Merges [59325] to the 6.7 branch.

Props johnbillion.
Fixes #61094