sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.

git-svn-id: https://develop.svn.wordpress.org/trunk@48617 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-25 19:38:34 +00:00
parent 4acb5a7ce8
commit f6b24a02f8
2 changed files with 27 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/wp-includes/customize/class-wp-customize-partial.php
View File

@ -68,7 +68,7 @@ class WP_Customize_Partial {
* IDs for settings tied to the partial.
*
* @since 4.5.0
* @var array
* @var string[]
*/
public $settings;
@ -135,9 +135,26 @@ class WP_Customize_Partial {
* @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.
* Optional. Array of properties for the new Partials object. Default empty array.
*
* @type array|string $settings All settings IDs tied to the partial. If undefined, `$id` will be used.
* @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.
* }
*/
public function __construct( WP_Customize_Selective_Refresh $component, $id, $args = array() ) {

28
src/wp-includes/customize/class-wp-customize-selective-refresh.php
View File

@ -83,29 +83,13 @@ final class WP_Customize_Selective_Refresh {
*
* @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.
* @see WP_Customize_Partial::__construct()
*
* @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.
* @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() ) {
if ( $id instanceof WP_Customize_Partial ) {