WP_Customize_Partial::__construct( WP_Customize_Selective_Refresh $component, string $id, array $args = array() )

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$componentWP_Customize_Selective_Refresh

Customize Partial Refresh plugin instance.

$idstring

Control ID.

$argsarrayoptional

Array of properties for the new Partials object. Default empty array.Default: array()

• $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.

Performance profile

How much work a call to WP_Customize_Partial::__construct() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

45–61

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 71.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• regexregular expression over the whole inputpreg_split()called directly

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Partial::__construct() can have, taken from its control-flow graph on PHP 8.5.

Source code

View on Trac ↗View on GitHub ↗

161	public function __construct( WP_Customize_Selective_Refresh $component, $id, $args = array() ) {162		$keys = array_keys( get_object_vars( $this ) );163		foreach ( $keys as $key ) {164			if ( isset( $args[ $key ] ) ) {165				$this->$key = $args[ $key ];166			}167		}168 169		$this->component       = $component;170		$this->id              = $id;171		$this->id_data['keys'] = preg_split( '/\[/', str_replace( ']', '', $this->id ) );172		$this->id_data['base'] = array_shift( $this->id_data['keys'] );173 174		if ( empty( $this->render_callback ) ) {175			$this->render_callback = array( $this, 'render_callback' );176		}177 178		// Process settings.179		if ( ! isset( $this->settings ) ) {180			$this->settings = array( $id );181		} elseif ( is_string( $this->settings ) ) {182			$this->settings = array( $this->settings );183		}184 185		if ( empty( $this->primary_setting ) ) {186			$this->primary_setting = current( $this->settings );187		}188	}

Changelog

Introduced in 4.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/customize/class-wp-customize-partial.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.