Opened 4 years ago
Closed 3 years ago
#48344 closed defect (bug) (fixed)
WP_Customize_Panel::__construct() is missing `$args` documentation
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 5.4 | Priority: | normal |
Severity: | minor | Version: | 5.2 |
Component: | Customize | Keywords: | needs-patch good-first-bug |
Focuses: | docs | Cc: |
Description
Documentation for the fields of the $args argument is missing:
https://developer.wordpress.org/reference/classes/wp_customize_panel/__construct/
I believe a good starting point would be the documentation of WP_Customize_Manager::add_panel():
https://developer.wordpress.org/reference/classes/wp_customize_manager/add_panel/
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.
Attachments (2)
Change History (10)
#2
@
4 years ago
- Summary changed from WP_Customize_Panel::__construct() is missing $args documentation to WP_Customize_Panel::__construct() is missing `$args` documentation
Also, as per https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#1-1-parameters-that-are-arrays, I believe in WP_Customize_Manager::add_panel()
, the arguments shouldn't be explicitly documented, just with a @see
...
Also, I believe the type of theme_supports should be
string|string[]
instead of juststring|array
;)