wp_default_packages_inline_scripts( WP_Scripts $scripts )

Compatibility

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

Parameters

$scriptsWP_Scripts

WP_Scripts object.

Performance profile

How much work a call to wp_default_packages_inline_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

Reaches the database via get_user_by().

Scaling

Constant

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

Instructions

243–262

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below wp_default_packages_inline_scripts()
• cacheobject cachewp_cache_get()one call below wp_default_packages_inline_scripts()
• serializeserialisationmaybe_unserialize()one call below wp_default_packages_inline_scripts()
• querycontent queryget_user_by()one call below wp_default_packages_inline_scripts()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

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

Uses · 13

• sanitize_url()Sanitizes a URL for database or redirect usage.
• get_rest_url()Retrieves the URL to a REST endpoint on a site.
• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• wp_create_nonce()Creates a cryptographic token tied to a specific action, user, user session, and window of time.
• admin_url()Retrieves the URL to the admin area for the current site.
• get_current_user_id()Gets the current user's ID.
• get_user_meta()Retrieves user meta field for a user.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• get_option()Retrieves an option value based on an option name.
• get_user_locale()Retrieves the locale of a user.
• __()Retrieves the translation of $text.
• DateTime::__construct()

Used by · 1

• wp_default_packages()Registers all the WordPress packages scripts.

Source code

View on Trac ↗View on GitHub ↗

348function wp_default_packages_inline_scripts( $scripts ) {349	global $wp_locale, $wpdb;350 351	if ( isset( $scripts->registered['wp-api-fetch'] ) ) {352		$scripts->registered['wp-api-fetch']->deps[] = 'wp-hooks';353	}354	$scripts->add_inline_script(355		'wp-api-fetch',356		sprintf(357			'wp.apiFetch.use( wp.apiFetch.createRootURLMiddleware( "%s" ) );',358			sanitize_url( get_rest_url() )359		),360		'after'361	);362	$scripts->add_inline_script(363		'wp-api-fetch',364		implode(365			"\n",366			array(367				sprintf(368					'wp.apiFetch.nonceMiddleware = wp.apiFetch.createNonceMiddleware( "%s" );',369					wp_installing() ? '' : wp_create_nonce( 'wp_rest' )370				),371				'wp.apiFetch.use( wp.apiFetch.nonceMiddleware );',372				'wp.apiFetch.use( wp.apiFetch.mediaUploadMiddleware );',373				sprintf(374					'wp.apiFetch.nonceEndpoint = "%s";',375					admin_url( 'admin-ajax.php?action=rest-nonce' )376				),377			)378		),379		'after'380	);381 382	$meta_key     = $wpdb->get_blog_prefix() . 'persisted_preferences';383	$user_id      = get_current_user_id();384	$preload_data = get_user_meta( $user_id, $meta_key, true );385	$scripts->add_inline_script(386		'wp-preferences',387		sprintf(388			'( function() {389				var serverData = %s;390				var userId = "%d";391				var persistenceLayer = wp.preferencesPersistence.__unstableCreatePersistenceLayer( serverData, userId );392				var preferencesStore = wp.preferences.store;393				wp.data.dispatch( preferencesStore ).setPersistenceLayer( persistenceLayer );394			} ) ();',395			wp_json_encode( $preload_data, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),396			$user_id397		)398	);399 400	// Backwards compatibility - configure the old wp-data persistence system.401	$scripts->add_inline_script(402		'wp-data',403		implode(404			"\n",405			array(406				'( function() {',407				'	var userId = ' . get_current_user_id() . ';',408				'	var storageKey = "WP_DATA_USER_" + userId;',409				'	wp.data',410				'		.use( wp.data.plugins.persistence, { storageKey: storageKey } );',411				'} )();',412			)413		)414	);415 416	// Calculate the timezone abbr (EDT, PST) if possible.417	$timezone_string = get_option( 'timezone_string', 'UTC' );418	$timezone_abbr   = '';419 420	if ( ! empty( $timezone_string ) ) {421		$timezone_date = new DateTime( 'now', new DateTimeZone( $timezone_string ) );422		$timezone_abbr = $timezone_date->format( 'T' );423	}424 425	$gmt_offset = get_option( 'gmt_offset', 0 );426 427	$scripts->add_inline_script(

Changelog

Introduced in 5.0.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/script-loader.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.