WP_Customize_Selective_Refresh::handle_render_partials_request()

Compatibility

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

Performance profile

How much work a call to WP_Customize_Selective_Refresh::handle_render_partials_request() 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 how much data it finds.

Instructions

4–105

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

Plugin surface

3 hooks

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

Called by

0

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

What it touches

• hookthird-party callbacksdo_action()called directly
• serializeserialisationjson_decode()called directly

Further down the call graph this can also reach option, cache, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 5 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while WP_Customize_Selective_Refresh::handle_render_partials_request() runs, in this order:

1. 1
   do_action( customize_render_partials_before )actionline 344 (+40 into the body)

   Fires immediately before partials are rendered.

2. 2
   do_action( customize_render_partials_after )actionline 393 (+89 into the body)

   Fires immediately after partials are rendered.

3. 3
   apply_filters( customize_render_partials_response )filterline 437 (+133 into the body)

   Filters the response from rendering the partials.

Uses · 10

• is_customize_preview()Whether the site is being previewed in the Customizer.
• wp_send_json_error()Sends a JSON response back to an Ajax request, indicating failure.
• status_header()Sets HTTP status header.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• do_action()Calls the callback functions that have been added to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_send_json_success()Sends a JSON response back to an Ajax request, indicating success.
• WP_Customize_Selective_Refresh::is_render_partials_request()Checks whether the request is for rendering partials.
• WP_Customize_Selective_Refresh::add_dynamic_partials()Registers dynamically-created partials.
• WP_Customize_Selective_Refresh::get_partial()Retrieves a partial.

Source code

View on Trac ↗View on GitHub ↗

304	public function handle_render_partials_request() {305		if ( ! $this->is_render_partials_request() ) {306			return;307		}308 309		/*310		 * Note that is_customize_preview() returning true will entail that the311		 * user passed the 'customize' capability check and the nonce check, since312		 * WP_Customize_Manager::setup_theme() is where the previewing flag is set.313		 */314		if ( ! is_customize_preview() ) {315			wp_send_json_error( 'expected_customize_preview', 403 );316		} elseif ( ! isset( $_POST['partials'] ) ) {317			wp_send_json_error( 'missing_partials', 400 );318		}319 320		// Ensure that doing selective refresh on 404 template doesn't result in fallback rendering behavior (full refreshes).321		status_header( 200 );322 323		$partials = json_decode( wp_unslash( $_POST['partials'] ), true );324 325		if ( ! is_array( $partials ) ) {326			wp_send_json_error( 'malformed_partials' );327		}328 329		$this->add_dynamic_partials( array_keys( $partials ) );330 331		/**332		 * Fires immediately before partials are rendered.333		 *334		 * Plugins may do things like call wp_enqueue_scripts() and gather a list of the scripts335		 * and styles which may get enqueued in the response.336		 *337		 * @since 4.5.0338		 *339		 * @param WP_Customize_Selective_Refresh $refresh  Selective refresh component.340		 * @param array                          $partials Placements' context data for the partials rendered in the request.341		 *                                                 The array is keyed by partial ID, with each item being an array of342		 *                                                 the placements' context data.343		 */344		do_action( 'customize_render_partials_before', $this, $partials );345 346		set_error_handler( array( $this, 'handle_error' ), error_reporting() );347 348		$contents = array();349 350		foreach ( $partials as $partial_id => $container_contexts ) {351			$this->current_partial_id = $partial_id;352 353			if ( ! is_array( $container_contexts ) ) {354				wp_send_json_error( 'malformed_container_contexts' );355			}356 357			$partial = $this->get_partial( $partial_id );358 359			if ( ! $partial || ! $partial->check_capabilities() ) {360				$contents[ $partial_id ] = null;361				continue;362			}363 364			$contents[ $partial_id ] = array();365 366			// @todo The array should include not only the contents, but also whether the container is included?367			if ( empty( $container_contexts ) ) {368				// Since there are no container contexts, render just once.369				$contents[ $partial_id ][] = $partial->render( null );370			} else {371				foreach ( $container_contexts as $container_context ) {372					$contents[ $partial_id ][] = $partial->render( $container_context );373				}374			}375		}376		$this->current_partial_id = null;377 378		restore_error_handler();379 380		/**381		 * Fires immediately after partials are rendered.382		 *383		 * Plugins may do things like call wp_footer() to scrape scripts output and return them

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