Перейти к содержимому

Composer

Blockstudio доступен на Packagist. Установить его через Composer можно несколькими способами в зависимости от конфигурации проекта.

В виде плагина

Используйте composer/installers, чтобы установить Blockstudio непосредственно в каталог wp-content/plugins/. Это стандартный способ для проектов WordPress под управлением Composer, например Bedrock.

JSON
{
  "require": {
    "composer/installers": "^2.0",
    "blockstudio/blockstudio": "^7.0"
  },
  "extra": {
    "installer-paths": {
      "wp-content/plugins/{$name}/": ["type:wordpress-plugin"]
    }
  }
}

Активируйте Blockstudio через панель администратора WordPress или WP-CLI:

Командная оболочка
wp plugin activate blockstudio

Автозагрузчик проекта Composer должен загрузиться в приложении WordPress, чтобы Composer мог зарегистрировать Blockstudio. В Bedrock это выполняется автоматически. В остальных случаях используйте обязательный плагин:

PHP
<?php
require_once dirname( __DIR__, 2 ) . '/vendor/autoload.php';

Если Blockstudio подключен через автозагрузчик Composer до начала загрузки плагинов в WordPress, загрузчик Composer откладывает инициализацию до появления среды загрузки плагинов. Благодаря этому Bedrock и другие настройки уровня сайта Composer могут подключать пакет заранее, не загружая Blockstudio до готовности API плагинов WordPress.

В виде обязательного плагина

Установите Blockstudio в mu-plugins/, чтобы он загружался автоматически без активации. Измените путь установки, указав каталог mu-plugins:

JSON
{
  "require": {
    "composer/installers": "^2.0",
    "blockstudio/blockstudio": "^7.0"
  },
  "extra": {
    "installer-paths": {
      "wp-content/mu-plugins/{$name}/": ["type:wordpress-plugin"]
    }
  }
}

WordPress автоматически загружает только файлы PHP в корне mu-plugins/, но не в подкаталогах. Добавьте файл загрузчика:

PHP
<?php
require_once WPMU_PLUGIN_DIR . '/blockstudio/blockstudio.php';

Активация не требуется. Blockstudio автоматически загружается при каждом запросе.

В составе темы

Установите Blockstudio как зависимость внутри темы. Все компоненты останутся в одном месте, и отдельный плагин не потребуется.

JSON
{
  "require": {
    "blockstudio/blockstudio": "^7.0"
  }
}

Загрузите пакет в файле functions.php темы:

PHP
<?php
require_once __DIR__ . '/vendor/autoload.php';

Blockstudio автоматически загружается через автозагрузчик Composer, когда его загружает WordPress. URL ресурсов указывают на правильный каталог темы. Блоки, определенные в каталоге blockstudio/ темы, работают так же, как при установке в виде плагина. Это также работает, если публичный каталог темы является символической ссылкой: Blockstudio сопоставляет физический путь пакета с URL активной или родительской темы, не раскрывая путь на сервере.

В составе плагина

Установите Blockstudio как зависимость внутри другого плагина. Здесь также используется автозагрузка.

JSON
{
  "require": {
    "blockstudio/blockstudio": "^7.0"
  }
}

Загрузите пакет в главном файле плагина:

PHP
<?php
/*
Plugin Name: My Plugin
*/
require_once __DIR__ . '/vendor/autoload.php';

URL ресурсов указывают на правильный каталог vendor плагина.

Проверки поддерживаемых режимов загрузки

Blockstudio непрерывно проверяет один и тот же пакет в четырех поддерживаемых позициях среды выполнения:

Режим Bootstrap
Плагин WordPress WordPress активирует blockstudio.php
Обязательный плагин Корневой загрузчик подключает точку входа пакета
Зависимость Composer в теме Тема подключает автозагрузчик Composer
Зависимость Composer в плагине Плагин-хост подключает автозагрузчик Composer

При любом режиме WordPress запускается одинаково: создается один экземпляр Blockstudio с определенным BLOCKSTUDIO_VERSION, без дополнительной абстракции хоста.

Пользовательский пакет URL

Установка в виде обычного плагина, обязательного плагина, плагина в составе другого плагина, активной или родительской темы и темы с символической ссылкой определяется автоматически. Для пользовательского развертывания, где пакет доступен через другой публичный URL, задайте BLOCKSTUDIO_URL до загрузки Composer Blockstudio. Укажите завершающий слеш:

PHP
<?php
define(
    'BLOCKSTUDIO_URL',
    get_stylesheet_directory_uri() . '/packages/blockstudio/'
);

require_once __DIR__ . '/vendor/autoload.php';

Также можно зарегистрировать blockstudio/url перед загрузкой автозагрузчика Composer:

PHP
<?php
add_filter(
    'blockstudio/url',
    function (string $url, string $directory): string {
        return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
    },
    10,
    2
);

require_once __DIR__ . '/vendor/autoload.php';

Фильтр получает разрешенный URL и физический каталог пакета.

Зависимости

Зависимости времени выполнения Blockstudio (TailwindPHP, ScssPhp, Minify) включены в плагин и изолированы в собственных пространствах имен. Единственная зависимость Composer, устанавливаемая в каталог vendor/, — это yahnis-elsts/plugin-update-checker, которая сама разрешает конфликты версий.

Код
composer.json requires:
  php >= 8.2
  yahnis-elsts/plugin-update-checker ^5.6

Обновления

Обновления для установок Composer поступают через Composer. Встроенное средство обновления GitHub автоматически отключается, если Blockstudio загружается из каталога vendor/.