WordPress.org

Make WordPress Core

Opened 7 weeks ago

Last modified 6 weeks ago

#48344 reviewing defect (bug)

WP_Customize_Panel::__construct() is missing `$args` documentation

Reported by: marekdedic Owned by: SergeyBiryukov
Milestone: 5.4 Priority: normal
Severity: minor Version: 5.2
Component: Customize Keywords: needs-patch good-first-bug
Focuses: docs Cc:
PR Number:

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)

48344.zip (724 bytes) - added by iaaxpage 6 weeks ago.
Patch with the arguments for the constructor
48344.diff (1.3 KB) - added by iaaxpage 6 weeks ago.
Arguments for the constructor

Download all attachments as: .zip

Change History (9)

#1 @marekdedic
7 weeks ago

Also, I believe the type of theme_supports should be string|string[] instead of just string|array ;)

#2 @marekdedic
7 weeks 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...

#3 @desrosj
7 weeks ago

  • Milestone changed from Awaiting Review to 5.4

#4 @desrosj
7 weeks ago

  • Keywords needs-patch good-first-bug added

This ticket was mentioned in Slack in #core by sergey. View the logs.


6 weeks ago

@iaaxpage
6 weeks ago

Patch with the arguments for the constructor

@iaaxpage
6 weeks ago

Arguments for the constructor

#7 @SergeyBiryukov
6 weeks ago

  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing
Note: See TracTickets for help on using tickets.