wp_register_page_routes( array $page_routes, string $register_function_name )

Compatibility

Present in 2 of the 5 tracked releases, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$page_routesarray

Array of route data for the page.

$register_function_namestring

Name of the function to call for registering each route.

Performance profile

How much work a call to wp_register_page_routes() 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 what you pass in.

Instructions

7–8

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

4

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

What one call costs · 1 distinct outcome

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

Uses · 2

• wp_deregister_script_module()Deregisters the script module.
• wp_register_script_module()Registers the script module if no script module with that script module identifier has already been registered.

Used by · 4

• wp_register_font_library_page_routes()Register routes for font-library page (full-page mode).
• wp_register_font_library_wp_admin_page_routes()Register routes for font-library page (wp-admin mode).
• wp_register_options_connectors_page_routes()Register routes for options-connectors page (full-page mode).
• wp_register_options_connectors_wp_admin_page_routes()Register routes for options-connectors page (wp-admin mode).

Source code

View on Trac ↗View on GitHub ↗

41function wp_register_page_routes( $page_routes, $register_function_name ) {42	// Load build constants43	$build_constants = require __DIR__ . '/constants.php';44 45	foreach ( $page_routes as $route ) {46		$content_handle = null;47		$route_handle = null;48 49		// Register content module if exists50		if ( $route['has_content'] ) {51			$content_asset_path = __DIR__ . "/routes/{$route['name']}/content.min.asset.php";52			if ( file_exists( $content_asset_path ) ) {53				$content_asset = require $content_asset_path;54				$content_handle = 'wp/routes/' . $route['name'] . '/content';55				$extension = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '.js' : '.min.js';56				// Deregister first to override any previously registered version57				// (e.g., Core's default modules when running as a plugin).58				wp_deregister_script_module( $content_handle );59				wp_register_script_module(60					$content_handle,61					$build_constants['build_url'] . 'routes/' . $route['name'] . '/content' . $extension,62					$content_asset['module_dependencies'] ?? array(),63					$content_asset['version'] ?? false64				);65			}66		}67 68		// Register route module if exists69		if ( $route['has_route'] ) {70			$route_asset_path = __DIR__ . "/routes/{$route['name']}/route.min.asset.php";71			if ( file_exists( $route_asset_path ) ) {72				$route_asset = require $route_asset_path;73				$route_handle = 'wp/routes/' . $route['name'] . '/route';74				$extension = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '.js' : '.min.js';75				// Deregister first to override any previously registered version76				// (e.g., Core's default modules when running as a plugin).77				wp_deregister_script_module( $route_handle );78				wp_register_script_module(79					$route_handle,80					$build_constants['build_url'] . 'routes/' . $route['name'] . '/route' . $extension,81					$route_asset['module_dependencies'] ?? array(),82					$route_asset['version'] ?? false83				);84			}85		}86 87		// Register route with page88		if ( function_exists( $register_function_name ) ) {89			call_user_func( $register_function_name, $route['path'], $content_handle, $route_handle );90		}91	}92}

Changelog

Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/build/routes.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.