Changeset 47386

Timestamp:

02/27/2020 08:27:45 PM (7 years ago)

Author:

SergeyBiryukov

Message:

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.

Location:

trunk/src/wp-includes

Files:

• class-wp-customize-manager.php (modified) (1 diff)
• class-wp-customize-section.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -3900 +3900 @@
          * @since 4.5.0 Return added WP_Customize_Section instance.
          *
+         * @see WP_Customize_Section::__construct()
+         *
          * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
-         * @param array                     $args {
-         *  Optional. Array of properties for the new Section object. Default empty array.
-         *
-         *     @type int             $priority           Priority of the section, defining the display order
-         *                                               of panels and sections. Default 160.
-         *     @type string          $panel              The panel this section belongs to (if any).
-         *                                               Default empty.
-         *     @type string          $capability         Capability required for the section.
-         *                                               Default 'edit_theme_options'
-         *     @type string|string[] $theme_supports     Theme features required to support the section.
-         *     @type string          $title              Title of the section to show in UI.
-         *     @type string          $description        Description to show in the UI.
-         *     @type string          $type               Type of the section.
-         *     @type callable        $active_callback    Active callback.
-         *     @type bool            $description_hidden Hide the description behind a help icon,
-         *                                               instead of inline above the first control.
-         *                                               Default false.
-         * }
+         * @param array                       $args Optional. Array of properties for the new Section object.
+         *                                          See WP_Customize_Section::__construct() for information
+         *                                          on accepted arguments. Default empty array.
          * @return WP_Customize_Section The instance of the section that was added.
          */

trunk/src/wp-includes/class-wp-customize-section.php

@@ -151 +151 @@
          * @param WP_Customize_Manager $manager Customizer bootstrap instance.
          * @param string               $id      A specific ID of the section.
-         * @param array                $args    Section arguments.
+         * @param array                $args    {
+         *     Optional. Array of properties for the new Section object. Default empty array.
+         *
+         *     @type int             $priority           Priority of the section, defining the display order
+         *                                               of panels and sections. Default 160.
+         *     @type string          $panel              The panel this section belongs to (if any).
+         *                                               Default empty.
+         *     @type string          $capability         Capability required for the section.
+         *                                               Default 'edit_theme_options'
+         *     @type string|string[] $theme_supports     Theme features required to support the section.
+         *     @type string          $title              Title of the section to show in UI.
+         *     @type string          $description        Description to show in the UI.
+         *     @type string          $type               Type of the section.
+         *     @type callable        $active_callback    Active callback.
+         *     @type bool            $description_hidden Hide the description behind a help icon,
+         *                                               instead of inline above the first control.
+         *                                               Default false.
+         * }
          */
         public function __construct( $manager, $id, $args = array() ) {