wp_localize_script( string $handle, string $object_name, $l10n ): bool
- Since
- 2.2.0
- Source
wp-includes/functions.wp-scripts.php:320
Description
Works only if the script has already been registered.
Accepts an associative array $l10n and creates a JavaScript object:
"$object_name": {
key: value,
key: value,
...
}Compatibility
- WordPress
- since 2.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$handlestring- Script handle the data will be attached to.
$object_namestring- Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
Example: '/[a-zA-Z0-9_]+/'. $l10n
Return value
bool- True if the script was successfully localized, false otherwise.
Performance profile
How much work a call to wp_localize_script() 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
- Scaling
- Constant
- Instructions
- 12
- Plugin surface
- None
- Called by
- 20
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 12.
Nothing here hands control to plugin code.
20 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_localize_script() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12 | wp_scripts(), ->localize() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 12 instructions, 12 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- wp_scripts()Initializes $wp_scripts if it has not been set.
Used by · 20
- WP_Customize_Background_Image_Control::enqueue()Enqueue control related scripts/styles.
- WP_Customize_Header_Image_Control::enqueue()Enqueues control related scripts/styles.
- WP_Customize_Manager::enqueue_control_scripts()Enqueues scripts for customize controls.
- WP_Customize_Nav_Menus::enqueue_scripts()Enqueues scripts and styles for Customizer pane.
- WP_MS_Themes_List_Table::prepare_items()Prepares the themes list for display.
- WP_Plugin_Install_List_Table::prepare_items()
- WP_Plugins_List_Table::prepare_items()
- WP_Site_Health::enqueue_scripts()Enqueues the site health scripts.
- the_custom_header_markup()Prints the markup for a custom header.
- twentyfifteen_customize_control_js()Binds JS listener to make Customizer color_scheme control.
- twentyfifteen_scripts()Enqueues scripts and styles.
- twentyfourteen_scripts()Enqueues scripts and styles for the front end.
Show all 20
- twentyseventeen_scripts()Enqueues scripts and styles.
- twentysixteen_customize_control_js()Binds the JS listener to make Customizer color_scheme control.
- twentysixteen_scripts()Enqueues scripts and styles.
- twentytwenty_customize_controls_enqueue_scripts()Enqueues scripts for customizer controls & settings.
- twentytwenty_customize_preview_init()Enqueues scripts for the customizer preview.
- wp_enqueue_media()Enqueues all scripts, styles, settings, and templates necessary to use all media JS APIs.
- wp_just_in_time_script_localization()Loads localized data on print rather than initialization.
- wp_localize_community_events()Localizes community events data that needs to be passed to dashboard.js.
Source code
function wp_localize_script( $handle, $object_name, $l10n ) { $wp_scripts = wp_scripts(); return $wp_scripts->localize( $handle, $object_name, $l10n );}Changelog
Introduced in 2.2.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$l10n retyped from array to untyped.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/functions.wp-scripts.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.