WP_Customize_Selective_Refresh::add_partial( WP_Customize_Partial|string $id, array $args = array() )
Adds a partial.
Description Description
Parameters Parameters
- $id
-
(WP_Customize_Partial|string) (Required) Customize Partial object, or Panel ID.
- $args
-
(array) (Optional) Array of properties for the new Partials object.
- 'type'
(string) Type of the partial to be created. - 'selector'
(string) The jQuery selector to find the container element for the partial, that is, a partial's placement. - 'settings'
(array) IDs for settings tied to the partial. - 'primary_setting'
(string) 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. - 'capability'
(string) Capability required to edit this partial. Normally this is empty and the capability is derived from the capabilities of the associated$settings. - 'render_callback'
(callable) 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. - 'container_inclusive'
(bool) Whether the container element is included in the partial, or if only the contents are rendered. - 'fallback_refresh'
(bool) 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.
Default value: array()
- 'type'
Return Return
(WP_Customize_Partial) The instance of the panel that was added.
Source Source
File: wp-includes/customize/class-wp-customize-selective-refresh.php
public function add_partial( $id, $args = array() ) {
if ( $id instanceof WP_Customize_Partial ) {
$partial = $id;
} else {
$class = 'WP_Customize_Partial';
/** This filter is documented in wp-includes/customize/class-wp-customize-selective-refresh.php */
$args = apply_filters( 'customize_dynamic_partial_args', $args, $id );
/** This filter is documented in wp-includes/customize/class-wp-customize-selective-refresh.php */
$class = apply_filters( 'customize_dynamic_partial_class', $class, $id, $args );
$partial = new $class( $this, $id, $args );
}
$this->partials[ $partial->id ] = $partial;
return $partial;
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 4.5.0 | Introduced. |