[wp-trac] [WordPress Trac] #48347: WP_Customize_Setting::__construct() is missing `$args` documentation
WordPress Trac
noreply at wordpress.org
Thu Oct 17 12:13:17 UTC 2019
#48347: WP_Customize_Setting::__construct() is missing `$args` documentation
--------------------------+-----------------------------
Reporter: marekdedic | Owner: (none)
Type: defect (bug) | Status: new
Priority: normal | Milestone: Awaiting Review
Component: Customize | Version: 5.2
Severity: minor | Keywords:
Focuses: docs |
--------------------------+-----------------------------
Documentation for the fields of the $args argument is missing:
https://developer.wordpress.org/reference/classes/wp_customize_setting/__construct/
I believe a good starting point would be the documentation of
WP_Customize_Manager::add_setting():
https://developer.wordpress.org/reference/classes/wp_customize_manager/add_setting/
Although I am not sure about the correctness of what's in there. But from
the implementation of add_panel, I'd say they should match.
As per https://make.wordpress.org/core/handbook/best-practices/inline-
documentation-standards/php/#1-1-parameters-that-are-arrays, there should
only be a @see comment in add_setting and the documentation should be in
the constructor I believe.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/48347>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list