wp_register_script() │ WP 2.1.0

Регистрирует файл скрипта, чтобы в дальнейшем подключать его используя функцию wp_enqueue_script().

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

При написании плагина или темы рекомендуется подключать скрипты через эту функцию или через её аналог wp_enqueue_script().

Хуков нет.

Возвращает

true|false. 3 возвращает true/false. До этого ничего не возвращала.

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

wp_register_script( $handle, $src, $deps, $ver, $in_footer );

$handle(строка) (обязательный)

Название скрипта. Должно быть уникальным, так как оно будет использоваться для вызова в дальнейшем в функции wp_enqueue_script().

$src(строка) (обязательный)

URL, путь до скрипта, например, http://example.com/wp-content/themes/my-theme/my-theme-script.js. Никогда не пишите URL напрямую, если он лежит в файлах движка или плагине, используйте специальные функции путей: plugins_url() для плагинов и get_template_directory_uri() для тем. Удаленные скрипты указывайте без протокола, так: //otherdomain.com/js/their-script.js.

$deps(массив)

Массив названий всех зарегистрированных скриптов, от которых зависит этот. Указанные тут скрипты будут загружены перед текущем. Укажите false, если нет зависимых скриптов.
По умолчанию: array()

$ver(string|false|null)

Версия скрипта, которая будет добавлена в конец пути к файлу в виде аргумента (?ver=1.1). Этот параметр нужен, чтобы корректная версия скрипта была загружена пользователями, в обход кэша.

• При false WordPress добавит в конец текущую версию WP.
• При null, никакая версия не будет добавлена.

По умолчанию: false

$args(array)

Параметры подключения скрипта. Поддерживаются два параметра:

До WP 6.3 этот параметр назывался $in_footer и принимал true/false.
С версии 6.3 параметр стал принимать массив данных, а прежний параметр $in_footer был перенесен в элемент массива in_footer:

[
	'in_footer' => true,
	'strategy'  => 'async',
]

Подробнее про это изменение читайте здесь.

По умолчанию: []

• in_footer(bool) - По умолчанию: false. Нужно ли выводить скрипт в подвале footer. По умолчанию скрипты располагаются в head части. Если этот параметр будет равен true скрипт будет выводиться конце body тега.

  Если из-за зависимости от других скриптов нет возможности подключить текущий скрипт в подвале, то значение этой переменой будет проигнорировано и скрипт будет подключен в head.

  В теме должна вызываться функция wp_footer() перед закрывающим тегом </body>.

  Ведет себя так же, как и предыдущая (до WP 6.3) реализация параметра $in_footer.

• strategy(string) - По умолчанию: ''. Указывает как (по какой стратегии) должен загружаться скрипт. Доступно два значения: defer и async для отложенных и асинхронных скриптов соответственно.

  По умолчанию используется блокирующее поведение, это сохраняет обратную совместимость с версиями WP ниже 6.3.

  Используйте wp_register_script_module(), чтобы зарегистрировать скрипт как модуль.

Примеры

add_action( 'init', 'register_remote_scripts' );
add_action( 'wp_enqueue_scripts', 'add_remote_scripts' );

function register_remote_scripts(){

	wp_register_script( 'someScript-js', 'https://domain.com/someScript.js' , '', '', true );
}

function add_remote_scripts(){

	wp_enqueue_script( 'someScript-js' );
}

add_action( 'wp_enqueue_scripts', 'add_remote_scripts' );

function add_remote_scripts(){

	wp_enqueue_script( 'someScript-js', 'https://domain.com/someScript.js' , '', '', true );
}

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

	$script_url = plugins_url( '/js/newscript.js', __FILE__ );

	wp_enqueue_script( 'custom-script', $script_url, ['jquery'], '1.0', true );
}

wp_register_script(
	'my_script',
	'https://example.com/path/to/my_script.js',
	[],
	'1.0',
	[
		'strategy' => 'defer'
	]
);

wp_register_script(
	'my_script',
	'https://example.com/path/to/my_script.js',
	[],
	'1.0',
	[
		'in_footer' => true,
		'strategy'  => 'async',
	]
);

add_action( 'init', 'register_myscripts' );
add_action( 'wp_enqueue_scripts', 'add_myscripts' );

// регистрируем скрипт
function register_myscripts(){

	$url = get_template_directory_uri() .'/myscript.js';

	wp_register_script( 'myfirstscript', $url, [ 'jquery', 'jquery-ui' ], 'v2.0', true );
}

// подключаем скрипты (ставим в очередь на вывод в html)
function add_myscripts() {

	wp_enqueue_script( 'myfirstscript' );
}

Добавить свой пример

Скрипты зарегистрированные WordPress