wp_default_script_modules()

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_default_script_modules() 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 or writes the filesystem via file_exists().

Scaling

Scales with input

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

Instructions

19–23

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

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

• filesystemfilesystem accessfile_exists()called directly
• hookthird-party callbacksapply_filters()one call below wp_default_script_modules()

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 · 2 distinct outcomes

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

Uses · 6

• wp_scripts_get_suffix()Returns the suffix that can be used for the scripts.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• wp_interactivity()Retrieves the main WP_Interactivity_API instance.
• includes_url()Retrieves the URL to the includes directory.
• wp_register_script_module()Registers the script module if no script module with that script module identifier has already been registered.
• wp_interactivity()::add_client_navigation_support_to_script_module()

Source code

View on Trac ↗View on GitHub ↗

167function wp_default_script_modules() {168	$suffix = defined( 'WP_RUN_CORE_TESTS' ) ? '.min' : wp_scripts_get_suffix();169 170	/*171	 * Expects multidimensional array like:172	 *173	 *     'interactivity/index.js' => array('dependencies' => array(…), 'version' => '…'),174	 *     'interactivity-router/index.js' => array('dependencies' => array(…), 'version' => '…'),175	 *     'block-library/navigation/view.js' => …176	 */177	$assets_file = ABSPATH . WPINC . '/assets/script-modules-packages.php';178	$assets      = file_exists( $assets_file ) ? include $assets_file : array();179 180	foreach ( $assets as $file_name => $script_module_data ) {181		/*182		 * Build the WordPress Script Module ID from the file name.183		 * Prepend `@wordpress/` and remove extensions and `/index` if present:184		 *   - interactivity/index.min.js         => @wordpress/interactivity185		 *   - interactivity-router/index.min.js  => @wordpress/interactivity-router186		 *   - block-library/navigation/view.js   => @wordpress/block-library/navigation/view187		 */188		$script_module_id = '@wordpress/' . preg_replace( '~(?:/index)?(?:\.min)?\.js$~D', '', $file_name, 1 );189 190		/*191		 * The Interactivity API is designed with server-side rendering as its primary goal, so all of its script modules192		 * should be loaded with low fetchpriority and printed in the footer since they should not be needed in the193		 * critical rendering path. Also, the @wordpress/a11y script module is intended to be used as a dynamic import194		 * dependency, in which case the fetchpriority is irrelevant. See <https://make.wordpress.org/core/2024/10/14/updates-to-script-modules-in-6-7/>.195		 * However, in case it is added as a static import dependency, the fetchpriority is explicitly set to be 'low'196		 * since the module should not be involved in the critical rendering path, and if it is, its fetchpriority will197		 * be bumped to match the fetchpriority of the dependent script.198		 */199		$args = array();200		if (201			str_starts_with( $script_module_id, '@wordpress/interactivity' ) ||202			str_starts_with( $script_module_id, '@wordpress/block-library' ) ||203			'@wordpress/a11y' === $script_module_id204		) {205			$args['fetchpriority'] = 'low';206			$args['in_footer']     = true;207		}208 209		// Marks all Core blocks as compatible with client-side navigation.210		if ( str_starts_with( $script_module_id, '@wordpress/block-library' ) ) {211			wp_interactivity()->add_client_navigation_support_to_script_module( $script_module_id );212		}213 214		// VIPS files and the video-conversion worker are always minified — the215		// non-minified versions are not shipped because they consist of large216		// inlined WASM/worker code with no debugging value.217		if ( str_starts_with( $file_name, 'vips/' ) || 'video-conversion/worker.js' === $file_name ) {218			$file_name = str_replace( '.js', '.min.js', $file_name );219		} elseif ( '' !== $suffix ) {220			$file_name = str_replace( '.js', $suffix . '.js', $file_name );221		}222 223		$path        = includes_url( "js/dist/script-modules/{$file_name}" );224		$module_deps = $script_module_data['module_dependencies'] ?? array();225		wp_register_script_module( $script_module_id, $path, $module_deps, $script_module_data['version'], $args );226	}227}

Changelog

Introduced in 6.7.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.1.0 tag, from src/wp-includes/script-modules.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.