A WordPress-centric search engine for devs and theme authors



wp_localize_script ›

Since2.2.0
Deprecatedn/a
› wp_localize_script ( $handle, $object_name, $l10n )
Parameters: (3)
  • (string) $handle Script handle the data will be attached to.
    Required: Yes
  • (string) $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable. Example: '/[a-zA-Z0-9_]+/'.
    Required: Yes
  • (array) $l10n The data itself. The data can be either a single or multi-dimensional array.
    Required: Yes
Links:
See:
  • WP_Dependencies::localize()
Returns:
  • (bool) True if the script was successfully localized, false otherwise.
Defined at:
Codex:

Localize a script.

Works only if the script has already been added.

Accepts an associative array $l10n and creates a JavaScript object:

"$object_name" = {
    key: value,
    key: value,
    ...
}


Related Functions: wp_playlist_scripts, wp_add_inline_script, wp_normalize_path, wp_initialize_site, _wp_footer_scripts

Source 

function wp_localize_script( $handle, $object_name, $l10n ) {
	global $wp_scripts;
	if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
		_wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
		return false;
	}

	return $wp_scripts->localize( $handle, $object_name, $l10n );
}