WP_Customize_Widgets::enqueue_scripts()

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_Widgets::enqueue_scripts() 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

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

168–249

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

Plugin surface

2 hooks

Third-party callbacks on 'admin_enqueue_scripts', 'enqueue_block_editor_assets' 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
• optionoption read or writeget_option()one call below WP_Customize_Widgets::enqueue_scripts()

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

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

Hooks and filters fired · 2

2 hooks fire while WP_Customize_Widgets::enqueue_scripts() runs, in this order:

1. 1
   do_action( admin_enqueue_scripts )actionline 706 (+7 into the body)

   Fires when enqueuing scripts for all admin pages.

2. 2
   do_action( enqueue_block_editor_assets )actionline 900 (+201 into the body)

   Fires after block assets have been enqueued for the editing interface.

Uses · 20

• wp_enqueue_style()Enqueues a CSS stylesheet.
• wp_enqueue_script()Enqueues a script.
• do_action()Calls the callback functions that have been added to an action hook.
• __()Retrieves the translation of $text.
• _x()Retrieves translated string with gettext context.
• get_bloginfo()Retrieves information about the current site.
• _n()Translates and retrieves the singular or plural form based on the supplied number.
• number_format_i18n()Converts float number to format based on the locale.
• esc_attr__()Retrieves the translation of $text and escapes it for safe use in an attribute.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• wp_use_widgets_block_editor()Determines whether or not to use the block editor to manage widgets.
• get_block_editor_settings()Returns the contextualized block editor settings for a selected editor context.

Source code

View on Trac ↗View on GitHub ↗

699	public function enqueue_scripts() {700		global $wp_scripts, $wp_registered_sidebars, $wp_registered_widgets;701 702		wp_enqueue_style( 'customize-widgets' );703		wp_enqueue_script( 'customize-widgets' );704 705		/** This action is documented in wp-admin/admin-header.php */706		do_action( 'admin_enqueue_scripts', 'widgets.php' );707 708		/*709		 * Export available widgets with control_tpl removed from model710		 * since plugins need templates to be in the DOM.711		 */712		$available_widgets = array();713 714		foreach ( $this->get_available_widgets() as $available_widget ) {715			unset( $available_widget['control_tpl'] );716			$available_widgets[] = $available_widget;717		}718 719		$widget_reorder_nav_tpl = sprintf(720			'<div class="widget-reorder-nav"><span class="move-widget" tabindex="0">%1$s</span><span class="move-widget-down" tabindex="0">%2$s</span><span class="move-widget-up" tabindex="0">%3$s</span></div>',721			__( 'Move to another area&hellip;' ),722			__( 'Move down' ),723			__( 'Move up' )724		);725 726		$move_widget_area_tpl = str_replace(727			array( '{description}', '{btn}' ),728			array(729				__( 'Select an area to move this widget into:' ),730				_x( 'Move', 'Move widget' ),731			),732			'<div class="move-widget-area">733				<p class="description">{description}</p>734				<ul class="widget-area-select">735					<% _.each( sidebars, function ( sidebar ){ %>736						<li class="" data-id="<%- sidebar.id %>" tabindex="0">737							<div><strong><%- sidebar.name %></strong></div>738							<div><%- sidebar.description %></div>739						</li>740					<% }); %>741				</ul>742				<div class="move-widget-actions">743					<button class="move-widget-btn button" type="button">{btn}</button>744				</div>745			</div>'746		);747 748		/*749		 * Gather all strings in PHP that may be needed by JS on the client.750		 * Once JS i18n is implemented (in #20491), this can be removed.751		 */752		$some_non_rendered_areas_messages    = array();753		$some_non_rendered_areas_messages[1] = html_entity_decode(754			__( 'Your theme has 1 other widget area, but this particular page does not display it.' ),755			ENT_QUOTES,756			get_bloginfo( 'charset' )757		);758		$registered_sidebar_count            = count( $wp_registered_sidebars );759		for ( $non_rendered_count = 2; $non_rendered_count < $registered_sidebar_count; $non_rendered_count++ ) {760			$some_non_rendered_areas_messages[ $non_rendered_count ] = html_entity_decode(761				sprintf(762					/* translators: %s: The number of other widget areas registered but not rendered. */763					_n(764						'Your theme has %s other widget area, but this particular page does not display it.',765						'Your theme has %s other widget areas, but this particular page does not display them.',766						$non_rendered_count767					),768					number_format_i18n( $non_rendered_count )769				),770				ENT_QUOTES,771				get_bloginfo( 'charset' )772			);773		}774 775		if ( 1 === $registered_sidebar_count ) {776			$no_areas_shown_message = html_entity_decode(777				sprintf(778					__( 'Your theme has 1 widget area, but this particular page does not display it.' )

Changelog

Introduced in 3.9.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/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.