[wp-trac] [WordPress Trac] #34855: Document wp_register_widget_control() $options as a hash notation

WordPress Trac noreply at wordpress.org
Sun Dec 6 15:50:51 UTC 2015


#34855: Document wp_register_widget_control() $options as a hash notation
--------------------------+----------------------------------------
 Reporter:  swissspidy    |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  Widgets       |    Version:
 Severity:  normal        |   Keywords:  needs-patch good-first-bug
  Focuses:  docs          |
--------------------------+----------------------------------------
 As per the `@todo` comment in `wp_register_widget_control()`, the
 `$options` parameter should be documented using hash notation.

 Currently the param is only somewhat documented in the function
 description. The hash notation would make it a lot more readable.

 See the [https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/php/#1-1-parameters-that-are-arrays PHP
 documentation standards] on how this could look like.

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


More information about the wp-trac mailing list