WordPress как на ладони
wordpress jino

wp_localize_script() WP 2.2

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

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

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

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

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

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

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

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

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

Хуков нет.

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

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

Примеры

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

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

$translation_array = array( 
	 'some_string' => __( 'Some string to translate' ), 
	 'a_value' => '10' 
);
wp_localize_script( 'jquery', 'object_name', $translation_array );

Получим в 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():

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 localize script: wp-includes/functions.wp-scripts.php WP 4.8.2

<?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__ );
		return false;
	}

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

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

Из метки: script

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

wp_localize_script 14 комментариев
Полезные 3 Вопросы 1 Все
  • Сергей

    Спасибо! Сайт в закладки.

    1
    Ответить3.3 года назад #
  • campusboy1847 cайт: wp-plus.ru

    Тимур, у тебя в статье Базовые знания для создания Ajax запросов в WordPress в примере есть такой код:

    wp_localize_script( 'jquery', 'myajax', 
    array(
       'url' => admin_url('admin-ajax.php')
    ));

    В результате, получим в head части сайта:

    <script type='text/javascript'>
    /* <![CDATA[ */
    var myajax = {"url":"http:\/\/wptest.ru\/wp-admin\/admin-ajax.php"};
    /* ]]> */
    </script>

    Здесь же в примере дан такой же код, но вывод якобы будет таким:

    <script type='text/javascript'>
    /* <![CDATA[ */
    var MyAjax = {"ajaxurl":"http://wptest.ru/wp-admin/admin-ajax.php"};
    /* ]]> */
    </script>

    Здесь в комментариях он отображается одинаково почему-то, но в самой статье там (в первой) идут слеши прямой и обратный в связке. Есть какая-то принципиальная разница?
    P.S.: О, в предпросмотре одинаково, а после публикации как положено smile

    Ответить2.1 года назад #
    • Kama4464

      Принципиальной разницы нет... wp_localize_script() так выводит. Зачем так я точно не знаю, думаю для валидности - это json формат к томуже... Можно на это тему почитать. В этой статья для наглядности без слэшей показал результат...

      Ответить2.1 года назад #
  • campusboy1847 cайт: wp-plus.ru

    Вставлял в functions.php темы twentyfifteen

    wp_localize_script( 'jQuery', 'AjaxURL', array( 'ajaxurl' => admin_url( 'admin-ajax.php' ) ) );

    Сразу сбивается кодировка, полный атас. Так и не понял, чего за дела, прописал жёсткую привязку в header.php. Тема была чистая без плагинов.

    Ответить2.1 года назад #
  • campusboy1847 cайт: wp-plus.ru

    Так и не смог заставить выводиться, писал так:

    ### Подключаем стили и JS ###
    function fsmod_scripts_styles() {
    	// Стили (имя, путь, зависимость, версия, вывод в футер)
    	wp_enqueue_style( 'reset', get_stylesheet_directory_uri() . '/css/reset.min.css', array(), null, 'all' );
    	wp_enqueue_style( 'main', get_stylesheet_directory_uri() . '/style.css', array('reset'), null, 'all' );
    	// javascript (имя, путь, зависимость, версия, вывод в футер)
    	wp_deregister_script( 'jquery' );
    	wp_register_script( 'jquery', '//ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js', false, null, true );
    	wp_enqueue_script( 'jquery' );
    	wp_enqueue_script( 'custom', get_stylesheet_directory_uri() . '/js/custom.js', array('jquery'), null, true);
    	wp_localize_script( 'jquery', 'SendData', array('ajax_url' => admin_url( 'admin-ajax.php' )  ) );
    }
    add_action( 'wp_enqueue_scripts', 'fsmod_scripts_styles' );
    Ответить1.9 года назад #
    • campusboy1847 cайт: wp-plus.ru

      Во прикол, а написал:

      wp_enqueue_script( 'custom', get_stylesheet_directory_uri() . '/js/custom.js', array('jquery'), null, true);
       wp_localize_script( 'custom', 'FS_SendData', array('ajax_url' => admin_url( 'admin-ajax.php' )  ) );

      И заработло. Получается если кастомно подключать jquery, то не хочет работать!

      Ответить1.9 года назад #
      • Kama4464

        Залез в коды сейчас, там такие строки есть:

                if ( $handle === 'jquery' )
        			$handle = 'jquery-core';

        Т.е. если указать jquery то локализация будет подключаться к jquery-core поэтому и не работало...

        Это единственное исключение вроде бы.

        Добавил предупреждение в описание.

        2
        Ответить1.9 года назад #
  • cron

    жаль что нельзя определить место вывода скрипта. хедер или футер

    Ответить1.1 года назад #
    • Kama4464

      Можно, можно... gamer

      wp_localize_script прикрепляется к уже подключенному скрипту. Который в свою очередь может быть подключен в шапку или подвал... В зависимости от этого и будет выведет localize_script...

      Ответить1.1 года назад #
  • campusboy1847 cайт: wp-plus.ru

    Очень похожа на wp_add_inline_script, там какой хочешь можно JS код прикрутить. Зато в wp_localize_script передаётся массивом, что довольно аккуратно выглядит и для всяких настроек очень даже хорош! good

    1
  • Михаил

    Можно ли как-то заставить wp_localize_script выводится в хедере, а сам wp_enqueue_script в футере?
    Это очень помогло бы с оптимизацией под пейдж спид.

    Ответить3 месяца назад #
    • Kama4464

      Повесь его на тот скрипт, который в хедар подключается... Если такого нет, то подключай его в подвале...

      Ответить3 месяца назад #
  • Marie

    А как можно проверить срабатывала ли уже эта функция с такими параметрами?
    То есть если wp_localize_script('main', 'user', $userParameters) уже один раз задал переменную user, то заново эту переменную не задавать.

    Ответить2 месяца назад #

Здравствуйте, !

Ваш комментарий