функция
since 2.1.0
wp_register_script()
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
wp_register_script( string $handle, string|false $src, string[] $deps = array(), string|bool|null $ver = false, array|bool $args = array() ): boolОписание
Русский перевод этого описания пока проверяется. Показан оригинал.
Registers a script to be enqueued later using the wp_enqueue_script() function.
Параметры
$handle
string
обязательный
Имя скрипта. Должно быть уникальным.
$src
string|false
обязательный
Полный URL скрипта или путь к скрипту относительно корневого каталога WordPress.
Если source установлен в false, скрипт является псевдонимом других скриптов, от которых он зависит.
$deps
string[]
необязательный
= array()
Массив дескрипторов зарегистрированных скриптов, от которых зависит этот скрипт.
$ver
string|bool|null
необязательный
= false
Строка, задающая номер версии скрипта, если он есть; она добавляется к URL в виде строки запроса для сброса кэша. Если version установлен в false, автоматически добавляется номер версии, равный текущей установленной версии WordPress.
Если установлено null, версия не добавляется.
$args
array|bool
необязательный
= array()
Массив дополнительных аргументов для скрипта.
Иначе это может быть логическое значение, которое определяет, печатается ли скрипт в подвале. По умолчанию false.
strategy stringНеобязательный. Если задан, может быть 'defer' или 'async'.
in_footer boolНеобязательный. Печатать ли скрипт в подвале. По умолчанию 'false'.
fetchpriority stringНеобязательный. Приоритет загрузки скрипта. По умолчанию 'auto'.
module_dependencies arrayНеобязательный. Идентификаторы зависимостей-модулей, загружаемых через динамический импорт.
Полный формат данных смотрите в параметре $deps функции wp_register_script_module().
Если он задан, скрипт должен либо печататься в подвале (с in_footer, установленным в true), либо использовать стратегию отложенной загрузки (defer), чтобы карта импорта модулей скрипта печаталась до выполнения скрипта. Иначе динамические импорты могут не разрешиться.
Возвращаемое значение
bool
Исходный код
wp-includes/functions-wp-scripts.php:278
function wp_register_script( $handle, $src, $deps = array(), $ver = false, $args = array() ) {
if ( ! is_array( $args ) ) {
$args = array(
'in_footer' => (bool) $args,
);
}
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
$wp_scripts = wp_scripts();
$registered = $wp_scripts->add( $handle, $src, $deps, $ver );
_wp_scripts_add_args_data( $wp_scripts, $handle, $args );
return $registered;
}История изменений
| Версия | Описание |
|---|---|
| 7.0.0 | The $module_dependencies parameter of type string[] was added to the $args parameter of type array. |
| 6.9.0 | The $fetchpriority parameter of type string was added to the $args parameter of type array. |
| 6.3.0 | The $in_footer parameter of type boolean was overloaded to be an $args parameter of type array. |
| 4.3.0 | A return value was added. |
| 2.1.0 | Introduced. |
