WP_Customize_Selective_Refresh::add_dynamic_partials( string[] $partial_ids ): 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

$partial_idsstring[]

Array of the partial IDs to add.

Return value

WP_Customize_Partial[]

Array of added WP_Customize_Partial instances.

Performance profile

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

5–6

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

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 · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Selective_Refresh::add_dynamic_partials() 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_dynamic_partials() runs, in this order:

1. 1
   apply_filters( customize_dynamic_partial_args )filterline 235 (+26 into the body)

   Filters a dynamic partial's constructor arguments.

2. 2
   apply_filters( customize_dynamic_partial_class )filterline 251 (+42 into the body)

   Filters the class used to construct partials.

Uses · 3

• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Customize_Selective_Refresh::get_partial()Retrieves a partial.
• WP_Customize_Selective_Refresh::add_partial()Adds a partial.

Used by · 1

• WP_Customize_Selective_Refresh::handle_render_partials_request()Handles the Ajax request to return the rendered partials for the requested placements.

Source code

View on Trac ↗View on GitHub ↗

209	public function add_dynamic_partials( $partial_ids ) {210		$new_partials = array();211 212		foreach ( $partial_ids as $partial_id ) {213 214			// Skip partials already created.215			$partial = $this->get_partial( $partial_id );216			if ( $partial ) {217				continue;218			}219 220			$partial_args  = false;221			$partial_class = 'WP_Customize_Partial';222 223			/**224			 * Filters a dynamic partial's constructor arguments.225			 *226			 * For a dynamic partial to be registered, this filter must be employed227			 * to override the default false value with an array of args to pass to228			 * the WP_Customize_Partial constructor.229			 *230			 * @since 4.5.0231			 *232			 * @param false|array $partial_args The arguments to the WP_Customize_Partial constructor.233			 * @param string      $partial_id   ID for dynamic partial.234			 */235			$partial_args = apply_filters( 'customize_dynamic_partial_args', $partial_args, $partial_id );236			if ( false === $partial_args ) {237				continue;238			}239 240			/**241			 * Filters the class used to construct partials.242			 *243			 * Allow non-statically created partials to be constructed with custom WP_Customize_Partial subclass.244			 *245			 * @since 4.5.0246			 *247			 * @param string $partial_class WP_Customize_Partial or a subclass.248			 * @param string $partial_id    ID for dynamic partial.249			 * @param array  $partial_args  The arguments to the WP_Customize_Partial constructor.250			 */251			$partial_class = apply_filters( 'customize_dynamic_partial_class', $partial_class, $partial_id, $partial_args );252 253			$partial = new $partial_class( $this, $partial_id, $partial_args );254 255			$this->add_partial( $partial );256			$new_partials[] = $partial;257		}258		return $new_partials;259	}

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.7.7 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.