[wp-trac] [WordPress Trac] #29876: Document default arguments for WP_Meta_Query

[WordPress Trac]

#29876: Document default arguments for WP_Meta_Query
--------------------------------+----------------------------------------
 Reporter:  DrewAPicture        |      Owner:
     Type:  defect (bug)        |     Status:  new
 Priority:  normal              |  Milestone:  Awaiting Review
Component:  Options, Meta APIs  |    Version:
 Severity:  normal              |   Keywords:  good-first-bug needs-patch
  Focuses:  docs                |
--------------------------------+----------------------------------------
 The default arguments for
 [https://developer.wordpress.org/reference/classes/wp_meta_query/
 WP_Meta_Query] need to be documented in the
 [https://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-1-parameters-that-are-arrays hash
 notation] style. The actual docs would go into the docblock for
 `WP_Meta_Query::__construct()`.

 Here are a couple of good example of documenting default arguments in hash
 notations:
 * [https://core.trac.wordpress.org/browser/trunk/src/wp-
 includes/user.php#L496 docs] for `WP_User_Query::prepare_query()`
 * [https://core.trac.wordpress.org/browser/trunk/src/wp-
 includes/query.php#L1446 docs] for `WP_Query::parse_query()`

 If it helps, you can use the `WP_Meta_Query`
 [http://codex.wordpress.org/Class_Reference/WP_Meta_Query Codex article]
 to find more information on the default arguments.

 This ticket is reserved for new contributors on the good-first-bug
 keyword.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/29876>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform