WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru

wp_localize_script() WP 2.2

Добавляет дополнительные данные перед указанным скриптом, который должен быть в очереди на вывод.

Скрипт, к которому подключается эта функцию обязательно должен быть добавлен на вывод с помощью wp_enqueue_script().

Изначально функция была создана для локализации строк скрипта. Т.е. перед ним определяются глобальные переменные строк, со значениями нужного перевода, а затем эти строки используются в основном скрипте. Но учитывая особенность работы скрипта, его можно использовать и для других целей, не только для локализации - например, можно перед нужным скриптом определить динамические данные через PHP, а затем использовать их в основном скрипте.

Функция чем-то похожа на wp_add_inline_script(), где можно добавить любой JS код. А в wp_localize_script() определяются переменные массивом, выглядит все это аккуратно и хорошо подходит для глобальных настроек JS скрипта. И та и другая функция прикрепляются к скрипту, который подключается через wp_enqueue_script() и зависят от него.

Функцию нужно подключать через хуки, потому что вызов функции за пределами хуков, может создать проблемы:

  • wp_enqueue_scripts, если нужно вызвать функцию в лицевой части сайта (фронт-энде).

  • admin_enqueue_scripts, чтобы вызвать в административной части.

  • login_enqueue_scripts - для страницы авторизации.

Заметка: wp_localize_script() нужно вызывать:

  • после того как скрипт был зарегистрирован функцией wp_register_script().
  • или добавлен в очередь на вывод с помощью wp_enqueue_script()
  • или, если скрипт уже существует в WordPress.

Если скрипт уже выведен на экран и только потом вызывается wp_localize_script(), то функция ничего не выведет.

Исключение. Если в $handle указать jquery то локализация будет подключаться к скрипту jquery-core.

Но если вы переопределили подключение jquery (указали что подключать его нужно с внешнего ресурса, т.е. удалили базовый вариант подключения в WordPress и указали свой), то скрипт jquery-core будет отключен, а это значит, что локализация не сработает, потому что она подключается к jquery-core, которого уже нет...

Чтобы однозначно избежать обоих этих нестыковок, надо сделать так:

wp_deregister_script( 'jquery-core' );
wp_deregister_script( 'jquery' );

wp_register_script( 'jquery-core', 'https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js', false, null, true );
wp_register_script( 'jquery', false, array('jquery-core'), null, true );
Работает на основе: WP_Scripts::localize()

Хуков нет.

Использование

wp_localize_script( $handle, $object_name, $l10n );
$handle(строка) (обязательный)
Название скрипта, перед которым будут добавлены данные. Скрипт должен быть зарегистрирован заранее.
По умолчанию: нет
$object_name(строка) (обязательный)
Название Javascript объекта, который будет содержать данные. Название должно быть уникальным, чтобы не вызвать конфликтов с другими скриптами! В названии нельзя использовать тире -, только латиницу a-zA-Z, подчеркивание _, а также можно примерять метод "верблюжьегоРегстра" (CamelCase).
По умолчанию: нет
$l10n(массив) (обязательный)
Данные перевода. Данные могут быть как в одномерном, так и в многомерном массиве.
По умолчанию: нет

Примеры

#1 Вставка глобальных данных

Пример вставки глобальных javascript данных перед рабочим скриптом (в примере рабочий скрипт это jquery). Вставляем этот код в functions.php:

add_action( 'wp_enqueue_scripts', 'action_function_name_7714', 99 );
function action_function_name_7714(){
	wp_localize_script( 'jquery', 'object_name', array( 
		'some_string' => __( 'Some string to translate' ), 
		 'a_value' => '10' 
	) );
}

Получим в head части сайта:

<script type='text/javascript'>
/* <![CDATA[ */
var object_name = {"some_string":"Some string to translate","a_value":"10"};
/* ]]> */
</script>
<script type='text/javascript' src='http://wptest.ru/wp-includes/js/jquery/jquery.js?ver=1.8.3'></script>

#2 Определим файл обработчик AJAX запросов

Добавим скрипт, а затем глобальных данных к нему. Тут мы добавляем javascript файл с AJAX запросом. В файле используется переменная MyAjax.ajaxurl, как URL для направления AJAX запроса. Этот URL мы определим через wp_localize_script():

add_action( 'wp_enqueue_scripts', 'action_function_name_7714' );
function action_function_name_7714(){

	wp_enqueue_script( 'my-ajax-request', get_template_directory_uri() . '/js/custom_script.js' );

	wp_localize_script( 'my-ajax-request', 'MyAjax', array( 'ajaxurl' => admin_url( 'admin-ajax.php' ) ) );

}

получим:

<script type='text/javascript'>
/* <![CDATA[ */
var MyAjax = {"ajaxurl":"http://wptest.ru/wp-admin/admin-ajax.php"};
/* ]]> */
</script>
<script type='text/javascript' src='http://wptest.ru/wp-content/themes/twentyeleven/js/custom_script.js?ver=3.5'></script>

Доступ к переменным в Javascript осуществляется так (для примера 2):

<script>
// в файле custom_script.js мы можем использовать переменную: MyAjax.ajaxurl
alert(MyAjax.ajaxurl); // выведет http://wptest.ru/wp-admin/admin-ajax.php
</script>

Заметки

#1. Данные в итоговом Javascript будут переданы как текст.

Если нужно обработать числа, вы должны использовать функцию parseInt() в принимаемом скрипте:

<script>
FinalZoom = map.getBoundsZoomLevel(bounds)-parseInt(data.a_value);
</script>

#2. Данные выводятся в теге <script>

Тег будет выводится вместе с указанным в первом параметре скриптом (прямо перед скриптом). Поэтому, не получится вывести данные с помощью wp_localize_script(), после того как указанный скрипт уже был добавлен, с использованием функций wp_enqueue_scripts или admin_enqueue_scripts.

Чтобы избежать подобных ошибок, всегда подключайте ваши скрипты в подвал (последний параметр $in_footer в функциях wp_register_scripts() или wp_enqueue_scripts(). Пример: wp_enqueue_script( $slug, $URL, $deps, $ver, true );.

Последний шанс локализовать скрипт это хук-событие wp_print_footer_scripts.

Заметки

  • Смотрите: WP_Scripts::localize()
  • Global. WP_Scripts. $wp_scripts The WP_Scripts object for printing scripts.

Список изменений

С версии 2.2.0 Введена.

Код wp_localize_script() WP 5.5.1

wp-includes/functions.wp-scripts.php
<?php
function wp_localize_script( $handle, $object_name, $l10n ) {
	global $wp_scripts;

	if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
		_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
		return false;
	}

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

Cвязанные функции

Из метки: script (скрипт)

Еще из раздела: Регистрация script и style

17 комментов
Полезные 4 Вопросы 1 Все