wp_localize_script( string $handle, string $object_name, array $l10n ): bool

Description

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_]+/'.

$l10narray

The data itself. The data can be either a single or multi-dimensional array.

Return

bool

True if the script was successfully localized, false otherwise.

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()
• 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()
• 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()Enqueue scripts and styles.
• twentyfourteen_scripts()Enqueue scripts and styles for the front end.

Source

View on Trac ↗View on GitHub ↗

225function wp_localize_script( $handle, $object_name, $l10n ) {226	$wp_scripts = wp_scripts();227 228	return $wp_scripts->localize( $handle, $object_name, $l10n );229}

History

Introduced in 2.2.0. One change between 6.7.7 and 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.7.7 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.