WP_Customize_Selective_Refresh::add_partial( WP_Customize_Partial|string $id, array $args = array() ): WP_Customize_Partial

Compatibility

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

Parameters

$idWP_Customize_Partial|string

Customize Partial object, or Partial ID.

$argsarrayoptional

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

Return value

WP_Customize_Partial

The instance of the partial that was added.

Performance profile

How much work a call to WP_Customize_Selective_Refresh::add_partial() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11–31

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

Plugin surface

2 hooks

Third-party callbacks on 'customize_dynamic_partial_args', 'customize_dynamic_partial_class' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()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_Selective_Refresh::add_partial() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_Customize_Selective_Refresh::add_partial() runs, in this order:

1. 1
   apply_filters( customize_dynamic_partial_args )filterline 102 (+7 into the body)

   Filters a dynamic partial's constructor arguments.

2. 2
   apply_filters( customize_dynamic_partial_class )filterline 105 (+10 into the body)

   Filters the class used to construct partials.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• WP_Customize_Selective_Refresh::add_dynamic_partials()Registers dynamically-created partials.

Source code

View on Trac ↗View on GitHub ↗

95	public function add_partial( $id, $args = array() ) {96		if ( $id instanceof WP_Customize_Partial ) {97			$partial = $id;98		} else {99			$class = 'WP_Customize_Partial';100 101			/** This filter is documented in wp-includes/customize/class-wp-customize-selective-refresh.php */102			$args = apply_filters( 'customize_dynamic_partial_args', $args, $id );103 104			/** This filter is documented in wp-includes/customize/class-wp-customize-selective-refresh.php */105			$class = apply_filters( 'customize_dynamic_partial_class', $class, $id, $args );106 107			$partial = new $class( $this, $id, $args );108		}109 110		$this->partials[ $partial->id ] = $partial;111		return $partial;112	}

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 7.1.0 tag, from src/wp-includes/customize/class-wp-customize-selective-refresh.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.