WP_Customize_Widgets::render_widget_partial( WP_Customize_Partial $partial, array $context ): string|false

Compatibility

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

Parameters

$partialWP_Customize_Partial

Partial.

$contextarray

Sidebar args supplied as container context.

• $sidebar_idstring

  ID for sidebar for widget to render into.

• $sidebar_instance_numberint

  Disambiguating instance number.

Return value

string|false

Performance profile

How much work a call to WP_Customize_Widgets::render_widget_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

13–65

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

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

• hookthird-party callbacksdo_action()one call below WP_Customize_Widgets::render_widget_partial()

Further down the call graph this can also reach option, cache, serialize, 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 · 3 distinct outcomes

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

Uses · 4

• is_registered_sidebar()Checks if a sidebar is registered.
• add_filter()Adds a callback function to a filter hook.
• dynamic_sidebar()Displays dynamic sidebar.
• remove_filter()Removes a callback function from a filter hook.

Source code

View on Trac ↗View on GitHub ↗

2015	public function render_widget_partial( $partial, $context ) {2016		$id_data   = $partial->id_data();2017		$widget_id = array_shift( $id_data['keys'] );2018 2019		if ( ! is_array( $context )2020			|| empty( $context['sidebar_id'] )2021			|| ! is_registered_sidebar( $context['sidebar_id'] )2022		) {2023			return false;2024		}2025 2026		$this->rendering_sidebar_id = $context['sidebar_id'];2027 2028		if ( isset( $context['sidebar_instance_number'] ) ) {2029			$this->context_sidebar_instance_number = (int) $context['sidebar_instance_number'];2030		}2031 2032		// Filter sidebars_widgets so that only the queried widget is in the sidebar.2033		$this->rendering_widget_id = $widget_id;2034 2035		$filter_callback = array( $this, 'filter_sidebars_widgets_for_rendering_widget' );2036		add_filter( 'sidebars_widgets', $filter_callback, 1000 );2037 2038		// Render the widget.2039		ob_start();2040		$this->rendering_sidebar_id = $context['sidebar_id'];2041		dynamic_sidebar( $this->rendering_sidebar_id );2042		$container = ob_get_clean();2043 2044		// Reset variables for next partial render.2045		remove_filter( 'sidebars_widgets', $filter_callback, 1000 );2046 2047		$this->context_sidebar_instance_number = null;2048		$this->rendering_sidebar_id            = null;2049		$this->rendering_widget_id             = null;2050 2051		return $container;2052	}

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.0.4 tag, from src/wp-includes/class-wp-customize-widgets.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.