Changeset 47387

Timestamp:

02/27/2020 08:34:49 PM (6 years ago)

Author:

SergeyBiryukov

Message:

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

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

Props iaaxpage, marekdedic.
Fixes #48344.

Location:

trunk/src/wp-includes

Files:

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

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

@@ -3802 +3802 @@
          * @since 4.5.0 Return added WP_Customize_Panel instance.
          *
-         * @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|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.
-         * }
+         * @see WP_Customize_Panel::__construct()
+         *
+         * @param WP_Customize_Panel|string $id   Customize Panel object, or ID.
+         * @param array                     $args Optional. Array of properties for the new Panel object.
+         *                                        See WP_Customize_Panel::__construct() for information
+         *                                        on accepted arguments. Default empty array.
          * @return WP_Customize_Panel The instance of the panel that was added.
          */
@@ -3902 +3894 @@
          * @see WP_Customize_Section::__construct()
          *
-         * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
+         * @param WP_Customize_Section|string $id   Customize Section object, or ID.
          * @param array                       $args Optional. Array of properties for the new Section object.
          *                                          See WP_Customize_Section::__construct() for information

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

@@ -140 +140 @@
          * @param WP_Customize_Manager $manager Customizer bootstrap instance.
          * @param string               $id      A specific ID for the panel.
-         * @param array                $args    Panel arguments.
+         * @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|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.
+         * }
          */
         public function __construct( $manager, $id, $args = array() ) {