[wp-trac] [WordPress Trac] #25367: Document WP_Query and related class arguments

WordPress Trac noreply at wordpress.org
Sat Sep 21 03:26:03 UTC 2013


#25367: Document WP_Query and related class arguments
----------------------------+------------------------------------
 Reporter:  DrewAPicture    |      Owner:
     Type:  task (blessed)  |     Status:  new
 Priority:  normal          |  Milestone:  3.7
Component:  Inline Docs     |    Version:
 Severity:  normal          |   Keywords:  has-patch dev-feedback
----------------------------+------------------------------------
 It's been a long time coming, but here we are.

 We've never had a fully documented list of `WP_Query` and related class
 arguments in core docs, however, with the inline docs effort in full
 swing, and the Code Reference on the way, there's an increasing urgency to
 have this list in place.

 And there's no better time to start than now.

 Goals of this ticket:
 1. Document all accepted `WP_Query` arguments
 2. Document all related class arguments, including:
 * `WP_Tax_Query` arguments
 * `WP_Date_Query` arguments
 * `WP_Meta_Query` arguments

 Goals of a future ticket:
 1. Remove duplicated `WP_Query` argument docs elsewhere in core inline
 docs.
 2. Back-reference mentions of accepting `WP_Query` parameters to the
 `WP_Query` docs

 '''The attached patch''' is a ''relatively'' complete start to this
 effort.

 Constructive input is welcome and encouraged for hashing out:
 1. What arguments should or shouldn't be documented
 2. Descriptions of said arguments in `WP_Query` or related classes
 3. Defaults and Accepted values for said arguments

 Let's get to it.

--
Ticket URL: <http://core.trac.wordpress.org/ticket/25367>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software


More information about the wp-trac mailing list