Changeset 47385

Timestamp:

02/27/2020 08:21:35 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify the type of theme_supports argument in various Customizer classes.

Props marekdedic.
See #48347.

Location:

trunk/src/wp-includes

Files:

• class-wp-customize-manager.php (modified) (2 diffs)
• class-wp-customize-panel.php (modified) (1 diff)
• class-wp-customize-section.php (modified) (1 diff)
• class-wp-customize-setting.php (modified) (2 diffs)

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

@@ -3804 +3804 @@
      * @param WP_Customize_Panel|string $id   Customize Panel object, or Panel 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.
-     *                                            Default 160.
-     *  @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       $description           Description to show in the UI.
-     *  @type string       $type                  Type of the panel.
-     *  @type callable     $active_callback       Active callback.
+     *     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. Default 160.
+     *     @type string          $capability      Capability required for the panel.
+     *                                            Default `edit_theme_options`.
+     *     @type string|string[] $theme_supports  Theme features required to support the panel.
+     *     @type string          $title           Title of the panel to show in UI.
+     *     @type string          $description     Description to show in the UI.
+     *     @type string          $type            Type of the panel.
+     *     @type callable        $active_callback Active callback.
      * }
      * @return WP_Customize_Panel The instance of the panel that was added.
@@ -3901 +3903 @@
      * @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|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 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.
+     *
+     *     @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.
      * }
      * @return WP_Customize_Section The instance of the section that was added.

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

@@ -70 +70 @@
 
     /**
-     * Theme feature support for the panel.
-     *
-     * @since 4.0.0
-     * @var string|array
+     * Theme features required to support the panel.
+     *
+     * @since 4.0.0
+     * @var string|string[]
      */
     public $theme_supports = '';

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

@@ -78 +78 @@
 
     /**
-     * Theme feature support for the section.
-     *
-     * @since 3.4.0
-     * @var string|array
+     * Theme features required to support the section.
+     *
+     * @since 3.4.0
+     * @var string|string[]
      */
     public $theme_supports = '';

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

@@ -52 +52 @@
 
     /**
-     * Feature a theme is required to support to enable this setting.
-     *
-     * @since 3.4.0
-     * @var string
+     * Theme features required to support the setting.
+     *
+     * @since 3.4.0
+     * @var string|string[]
      */
     public $theme_supports = '';
@@ -158 +158 @@
      *                                      Can be a theme mod or option name.
      * @param array                $args    {
-     *  Optional. Array of properties for the new Setting object. Default empty array.
-     *
-     *  @type string       $type                  Type of the setting. Default 'theme_mod'.
-     *  @type string       $capability            Capability required for the setting. Default 'edit_theme_options'
-     *  @type string|array $theme_supports        Theme features required to support the panel. Default is none.
-     *  @type string       $default               Default value for the setting. Default is empty string.
-     *  @type string       $transport             Options for rendering the live preview of changes in Customizer.
-     *                                            Using 'refresh' makes the change visible by reloading the whole preview.
-     *                                            Using 'postMessage' allows a custom JavaScript to handle live changes.
-     *                                            Default is 'refresh'.
-     *  @type callable     $validate_callback     Server-side validation callback for the setting's value.
-     *  @type callable     $sanitize_callback     Callback to filter a Customize setting value in un-slashed form.
-     *  @type callable     $sanitize_js_callback  Callback to convert a Customize PHP setting value to a value that is
-     *                                            JSON serializable.
-     *  @type bool         $dirty                 Whether or not the setting is initially dirty when created.
+     *     Optional. Array of properties for the new Setting object. Default empty array.
+     *
+     *     @type string          $type                 Type of the setting. Default 'theme_mod'.
+     *     @type string          $capability           Capability required for the setting. Default 'edit_theme_options'
+     *     @type string|string[] $theme_supports       Theme features required to support the panel. Default is none.
+     *     @type string          $default              Default value for the setting. Default is empty string.
+     *     @type string          $transport            Options for rendering the live preview of changes in Customizer.
+     *                                                 Using 'refresh' makes the change visible by reloading the whole preview.
+     *                                                 Using 'postMessage' allows a custom JavaScript to handle live changes.
+     *                                                 Default is 'refresh'.
+     *     @type callable        $validate_callback    Server-side validation callback for the setting's value.
+     *     @type callable        $sanitize_callback    Callback to filter a Customize setting value in un-slashed form.
+     *     @type callable        $sanitize_js_callback Callback to convert a Customize PHP setting value to a value that is
+     *                                                 JSON serializable.
+     *     @type bool            $dirty                Whether or not the setting is initially dirty when created.
      * }
      */