Adds a partial.

• WP_Customize_Partial::__construct()

$id WP_Customize_Partial|string Required

Customize Partial object, or Partial ID.

$args array Optional

Array of properties for the new Partials object.
See WP_Customize_Partial::__construct() for information on accepted arguments.

More Arguments from WP_Customize_Partial::__construct( ... $args )

Array of properties for the new Partials object.

• typestring
  Type of the partial to be created.
• selectorstring
  The jQuery selector to find the container element for the partial, that is, a partial's placement.
• settingsstring[]
  IDs for settings tied to the partial. If undefined, $id will be used.
• primary_settingstring
  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.
• capabilitystring
  Capability required to edit this partial.
  Normally this is empty and the capability is derived from the capabilities of the associated $settings.
• render_callbackcallable
  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_inclusivebool
  Whether the container element is included in the partial, or if only the contents are rendered.
• fallback_refreshbool
  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: array()

WP_Customize_Partial The instance of the partial that was added.

File: wp-includes/customize/class-wp-customize-selective-refresh.php. View all references

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;
}