wp_enqueue_script() — описание функции WordPress на русском

Сигнатура

wp_enqueue_script( string $handle, string $src = '', string[] $deps = array(), string|bool|null $ver = false, array|bool $args = array() )

Описание

Русский перевод этого описания пока проверяется. Показан оригинал.

Registers the script if $src provided (does NOT overwrite), and enqueues it.

Параметры

$handle string обязательный

Имя скрипта. Должно быть уникальным.

$src string необязательный = ''

Полный URL скрипта или путь к скрипту относительно корневого каталога WordPress.

$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), чтобы карта импорта модулей скрипта печаталась до выполнения скрипта. Иначе динамические импорты могут не разрешиться.

Исходный код

wp-includes/functions-wp-scripts.php:473

function wp_enqueue_script( $handle, $src = '', $deps = array(), $ver = false, $args = array() ) {
	_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );

	$wp_scripts = wp_scripts();

	if ( $src || ! empty( $args ) ) {
		/** @var array{ 0: non-empty-string, 1?: string } $_handle */
		$_handle = explode( '?', $handle );
		if ( ! is_array( $args ) ) {
			$args = array(
				'in_footer' => (bool) $args,
			);
		}

		if ( $src ) {
			$wp_scripts->add( $_handle[0], $src, $deps, $ver );
		}
		if ( ! empty( $args ) ) {
			_wp_scripts_add_args_data( $wp_scripts, $_handle[0], $args );
		}
	}

	$wp_scripts->enqueue( $handle );
}

История изменений

Версия	Описание
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.
2.1.0	Introduced.