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

Timestamp:

05/19/2017 08:24:58 PM (8 years ago)

Author:

westonruter

Message:

Docs: Improve phpdoc for WP_Customize_Manager, WP_Customize_Control, WP_Customize_Setting, and WP_Customize_Selective_Refresh.

Props 4nickpick, sagarprajapati, ketuchetan, BharatKambariya, mrahmadawais, westonruter.
Fixes #39671.

File:

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

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

@@ -89 +89 @@
      *
      * @since 4.5.0
-     * @access public
      *
      * @param WP_Customize_Partial|string $id   Customize Partial object, or Panel ID.
-     * @param array                       $args Optional. Partial arguments. Default empty array.
+     * @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.
      */