[wp-trac] [WordPress Trac] #61307: Wrong variable name in filter documentation

WordPress Trac noreply at wordpress.org
Fri Jun 7 21:57:40 UTC 2024


#61307: Wrong variable name in filter documentation
--------------------------+------------------------
 Reporter:  david.binda   |       Owner:  audrasjb
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  6.6
Component:  Query         |     Version:  6.0
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+------------------------

Comment (by ironprogrammer):

 I agree that `$clauses` more accurately describes the associate array
 expected here after `compact( $pieces )`, but it does look funny for the
 comment to not allude to the obvious use of `$pieces` in context.

 The DocBlock at https://core.trac.wordpress.org/browser/trunk/src/wp-
 includes/class-wp-query.php#L2934 is verbose in describing what `$clauses`
 represents. Would it help for the other filter calls to include these
 details to avoid ambiguity?

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/61307#comment:6>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list