Changeset 48617

Timestamp:

07/25/2020 07:38:34 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add a reference to WP_Customize_Partial::__construct() for information on accepted arguments in WP_Customize_Selective_Refresh::add_partial().

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

Props marekdedic.
See #49572.

Location:

trunk/src/wp-includes/customize

Files:

• class-wp-customize-partial.php (modified) (2 diffs)
• class-wp-customize-selective-refresh.php (modified) (1 diff)

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

@@ -69 +69 @@
      *
      * @since 4.5.0
-     * @var array
+     * @var string[]
      */
     public $settings;
@@ -135 +135 @@
      * @param WP_Customize_Selective_Refresh $component Customize Partial Refresh plugin instance.
      * @param string                         $id        Control ID.
-     * @param array                          $args      {
-     *     Optional. Arguments to override class property defaults.
-     *
-     *     @type array|string $settings All settings IDs tied to the partial. If undefined, `$id` will be used.
+     * @param array                          $args {
+     *     Optional. Array of properties for the new Partials object. Default empty array.
+     *
+     *     @type string   $type                  Type of the partial to be created.
+     *     @type string   $selector              The jQuery selector to find the container element for the partial, that is,
+     *                                           a partial's placement.
+     *     @type string[] $settings              IDs for settings tied to the partial. If undefined, `$id` will be used.
+     *     @type string   $primary_setting       The ID for the setting that this partial is primarily responsible for
+     *                                           rendering. If not supplied, it will default to the ID of the first setting.
+     *     @type string   $capability            Capability required to edit this partial.
+     *                                           Normally this is empty and the capability is derived from the capabilities
+     *                                           of the associated `$settings`.
+     *     @type callable $render_callback       Render callback.
+     *                                           Callback is called with one argument, the instance of WP_Customize_Partial.
+     *                                           The callback can either echo the partial or return the partial as a string,
+     *                                           or return false if error.
+     *     @type bool     $container_inclusive   Whether the container element is included in the partial, or if only
+     *                                           the contents are rendered.
+     *     @type bool     $fallback_refresh      Whether to refresh the entire preview in case a partial cannot be refreshed.
+     *                                           A partial render is considered a failure if the render_callback returns
+     *                                           false.
      * }
      */

trunk/src/wp-includes/customize/class-wp-customize-selective-refresh.php

@@ -84 +84 @@
      * @since 4.5.0
      *
-     * @param WP_Customize_Partial|string $id   Customize Partial object, or Panel ID.
-     * @param array                       $args {
-     *  Optional. Array of properties for the new Partials object. Default empty array.
-     *
-     *  @type string   $type                  Type of the partial to be created.
-     *  @type string   $selector              The jQuery selector to find the container element for the partial, that is, a partial's placement.
-     *  @type array    $settings              IDs for settings tied to the partial.
-     *  @type string   $primary_setting       The ID for the setting that this partial is primarily responsible for
-     *                                        rendering. If not supplied, it will default to the ID of the first setting.
-     *  @type string   $capability            Capability required to edit this partial.
-     *                                        Normally this is empty and the capability is derived from the capabilities
-     *                                        of the associated `$settings`.
-     *  @type callable $render_callback       Render callback.
-     *                                        Callback is called with one argument, the instance of WP_Customize_Partial.
-     *                                        The callback can either echo the partial or return the partial as a string,
-     *                                        or return false if error.
-     *  @type bool     $container_inclusive   Whether the container element is included in the partial, or if only
-     *                                        the contents are rendered.
-     *  @type bool     $fallback_refresh      Whether to refresh the entire preview in case a partial cannot be refreshed.
-     *                                        A partial render is considered a failure if the render_callback returns
-     *                                        false.
-     * }
-     * @return WP_Customize_Partial             The instance of the panel that was added.
+     * @see WP_Customize_Partial::__construct()
+     *
+     * @param WP_Customize_Partial|string $id   Customize Partial object, or Partial ID.
+     * @param array                       $args Optional. Array of properties for the new Partials object.
+     *                                          See WP_Customize_Partial::__construct() for information
+     *                                          on accepted arguments. Default empty array.
+     * @return WP_Customize_Partial The instance of the partial that was added.
      */
     public function add_partial( $id, $args = array() ) {