Changeset 42039

Timestamp:

10/29/2017 03:21:27 AM (8 years ago)

Author:

westonruter

Message:

Customize: Fix phpdoc for params in WP_Customize_Manager::add_section().

Amends [40804].
See #39671.
Fixes #42372.

File:

• trunk/src/wp-includes/class-wp-customize-manager.php (modified) (1 diff)

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

@@ -3766 +3766 @@
      * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
      * @param array                     $args {
-     *  Optional. Array of properties for the new Panel object. Default empty array.
-     *  @type int          $priority              Priority of the panel, defining the display order of panels and sections.
+     *  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                 Priority of the panel, defining the display order of panels and sections.
-     *  @type string       $capability            Capability required for the panel. Default 'edit_theme_options'
-     *  @type string|array $theme_supports        Theme features required to support the panel.
-     *  @type string       $title                 Title of the panel to show in UI.
+     *  @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|array $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 panel.
+     *  @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 . Default false.
+     *  @type bool         $description_hidden    Hide the description behind a help icon, instead of inline above the first control. Default false.
      * }
      * @return WP_Customize_Section             The instance of the section that was added.