Функция wp_register_script(): Регистрация скриптов в WordPress

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

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

Параметры

• $handle (string, обязательный)
  Уникальное имя для скрипта. Используется для ссылки на скрипт при его подключении.
• $src (string|false, обязательный)
  Полный URL или путь к скрипту относительно корневой директории WordPress. Если значение установлено в false, скрипт будет алиасом для других скриптов, от которых он зависит.
• $deps (string[], необязательный)
  Массив идентификаторов других зарегистрированных скриптов, от которых зависит текущий скрипт. Например, jquery. По умолчанию — пустой массив.
• $ver (string|bool|null, необязательный)
  Версия скрипта. Будет добавлена к URL скрипта в виде параметра ?ver=1.0.0 для контроля кэширования. Если false, будет использована версия WordPress. Если null, версия не будет добавлена.
• $args (array|bool, необязательный)
  Опции для загрузки скрипта:
  • in_footer (bool) — указывает, должен ли скрипт быть загружен в нижней части страницы (в футере). По умолчанию: false.
  • strategy (string) — стратегия загрузки скрипта: 'defer' или 'async'. Доступно с WordPress 6.3.

Возвращаемое значение

• bool
  Возвращает true, если скрипт был успешно зарегистрирован, или false, если регистрация не удалась.

Когда использовать wp_register_script()

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

Основные хуки для регистрации и подключения скриптов

• init: Используется для регистрации скриптов на всех страницах сайта, включая админку.
• wp_enqueue_scripts: Применяется для подключения скриптов на фронтэнде.
• admin_enqueue_scripts: Подключение скриптов в админке WordPress.
• login_enqueue_scripts: Подключение скриптов на странице авторизации.

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

Пример 1: Регистрация и подключение скрипта в плагине

function myplugin_register_scripts() {
    wp_register_script(
        'myplugin-script', 
        plugins_url('js/myplugin-script.js', __FILE__), 
        array('jquery'), 
        '1.0.0', 
        true
    );
    wp_enqueue_script('myplugin-script');
}
add_action('wp_enqueue_scripts', 'myplugin_register_scripts');

В этом примере скрипт myplugin-script.js регистрируется с зависимостью от jQuery и подключается в футере.

Пример 2: Использование внутри класса плагина

class MyPlugin_Scripts {

    public function __construct() {
        add_action('wp_enqueue_scripts', array($this, 'register_scripts'));
    }

    public function register_scripts() {
        wp_register_script(
            'myplugin-class-script',
            plugins_url('js/myplugin-class-script.js', __FILE__), 
            array(), 
            '1.0.0', 
            true
        );
        wp_enqueue_script('myplugin-class-script');
    }
}

new MyPlugin_Scripts();

Этот код регистрирует и подключает скрипт внутри класса плагина.

Пример 3: Регистрация скрипта с использованием стратегии загрузки defer

function enqueue_deferred_script() {
    wp_register_script(
        'my-deferred-script',
        get_template_directory_uri() . '/js/deferred.js',
        array(),
        '1.0.0',
        array('strategy' => 'defer')
    );
    wp_enqueue_script('my-deferred-script');
}
add_action('wp_enqueue_scripts', 'enqueue_deferred_script');

Скрипт deferred.js будет загружен с атрибутом defer, что позволит браузеру выполнить его после загрузки DOM.

Пример 4: Условная регистрация и подключение скрипта

function conditionally_enqueue_scripts() {
    wp_register_script(
        'dependent-script', 
        get_template_directory_uri() . '/js/dependent.js'
    );
    
    wp_enqueue_script(
        'main-script', 
        get_template_directory_uri() . '/js/main.js', 
        array('dependent-script')
    );
}
add_action('wp_enqueue_scripts', 'conditionally_enqueue_scripts');

В этом примере скрипт dependent.js будет автоматически подключен перед main.js при его добавлении в очередь.

Управление стратегиями загрузки

Начиная с WordPress 6.3, параметр $in_footer был заменен на массив с ключом in_footer, и добавилась возможность задавать стратегию загрузки скриптов: defer (отложенная загрузка) и async (асинхронная загрузка).

Примеры использования:

• Отложенная загрузка (defer):

wp_register_script(
    'my-defer-script',
    'https://example.com/script.js',
    [],
    '1.0',
    [ 'strategy' => 'defer' ]
);

• Асинхронная загрузка (async):

wp_register_script(
    'my-async-script',
    'https://example.com/script.js',
    [],
    '1.0',
    [ 'in_footer' => true, 'strategy' => 'async' ]
);

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

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

Пример регистрации и подключения в одном шаге

Если вы уверены, что скрипт нужен только на одной странице, его можно сразу зарегистрировать и подключить:

add_action( 'wp_enqueue_scripts', 'enqueue_my_scripts' );

function enqueue_my_scripts() {
    wp_enqueue_script( 'custom-script', plugins_url( '/js/newscript.js', __FILE__ ), ['jquery'], '1.0', true );
}

Список встроенных скриптов WordPress

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

Чтобы подключить, например, jQuery:

wp_enqueue_script( 'jquery' );

Все скрипты

Заключение

Функция wp_register_script() — это мощный инструмент для управления загрузкой скриптов в WordPress. Она позволяет избежать повторной регистрации скриптов на каждой странице и помогает оптимизировать производительность сайта.