WordPress.org

Make WordPress Core

Opened 6 months ago

Closed 5 weeks ago

#48346 closed defect (bug) (fixed)

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

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

Description

Documentation for the fields of the $args argument is missing:

https://developer.wordpress.org/reference/classes/wp_customize_section/__construct/

I believe a good starting point would be the documentation of WP_Customize_Manager::add_section():

https://developer.wordpress.org/reference/classes/wp_customize_manager/add_section/

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_section and the documentation should be in the constructor I believe.

Attachments (2)

48346.patch (3.6 KB) - added by amolv 5 months ago.
48346.1.patch (3.6 KB) - added by amolv 5 months ago.

Download all attachments as: .zip

Change History (11)

#1 @marekdedic
6 months ago

Also, I believe the type of theme_supports could be narrowed from string|array to string|string[] ;)

#2 @johnbillion
6 months ago

  • Keywords needs-patch good-first-bug added

#3 @desrosj
6 months ago

  • Milestone changed from Awaiting Review to 5.4

@amolv
5 months ago

@amolv
5 months ago

#4 @amolv
5 months ago

  • Keywords has-patch added; needs-patch removed

48346.1.patch to add documetation to WP_Customize_Section::__construct() and reference to WP_Customize_Manager::add_section.

Last edited 5 months ago by SergeyBiryukov (previous) (diff)

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


5 months ago

#6 @SergeyBiryukov
5 months ago

  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

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


5 weeks ago

#8 @mikeschroder
5 weeks ago

  • Keywords needs-refresh added

We took a look at this in triage, and it looks like the patch no longer applies, so marking it as needs-refresh.

#9 @SergeyBiryukov
5 weeks ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 47386:

Docs: Add a reference to WP_Customize_Section::__construct() for information on accepted arguments in WP_Customize_Manager::add_section().

Synchronize the documentation between two places, use WP_Customize_Section::__construct() as the canonical source.

Props amolv, marekdedic.
Fixes #48346.

Note: See TracTickets for help on using tickets.