WordPress.org

Make WordPress Core

Opened 4 weeks ago

Last modified 3 weeks ago

#48347 reviewing defect (bug)

WP_Customize_Setting::__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
Focuses: docs Cc:
PR Number:

Description

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.

Attachments (1)

48347.diff (4.4 KB) - added by tmanoilov 3 weeks ago.

Download all attachments as: .zip

Change History (7)

#1 @marekdedic
4 weeks ago

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

Last edited 4 weeks ago by marekdedic (previous) (diff)

#2 @johnbillion
4 weeks ago

  • Keywords needs-patch good-first-bug added

#3 @desrosj
4 weeks ago

  • Milestone changed from Awaiting Review to 5.4

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


3 weeks ago

@tmanoilov
3 weeks ago

#5 @tmanoilov
3 weeks ago

  • Keywords has-patch added; needs-patch removed

Hello, I'm a first time contributor so please review and let me know if anything else needs to be done.

#6 @SergeyBiryukov
3 weeks ago

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