[wp-meta] [Making WordPress.org] #1913: Expand documentation of WP_Term_Query() in Code Reference.
Making WordPress.org
noreply at wordpress.org
Wed Aug 17 13:18:38 UTC 2016
#1913: Expand documentation of WP_Term_Query() in Code Reference.
---------------------------+-----------------
Reporter: kevinwhoffman | Owner:
Type: enhancement | Status: new
Priority: normal | Milestone:
Component: Developer Hub | Keywords:
---------------------------+-----------------
With the release of 4.6, many devs will be researching
[https://developer.wordpress.org/reference/classes/wp_term_query/
WP_Term_Query()] only to find that its Code Reference page has very little
information. I was expecting documentation similar to
[https://developer.wordpress.org/reference/classes/wp_query/ WP_Query()].
Upon further investigation, I found that much of the information I was
looking for is actually in the docs of the
[https://developer.wordpress.org/reference/classes/wp_term_query/__construct/
WP_Term_Query::__construct()] method. I only realized this after reading
the DocBlock in the source code, which includes `@see
WP_Term_Query::__construct() for accepted arguments.`. However that info
is nowhere to be found in the Code Reference. The the only way to find it
is to click `__construct()` in the Related section.
Can we better reflect the documentation from the `__construct()` page
(specifically the acceptable arguments) in the docs for WP_Term_Query()?
This could be accomplished either through examples, or at least a more
obvious callout that refers you to the `__construct()` method for anyone
researching how to format the query.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/1913>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list