跳转到正文

Composer

Blockstudio可通过Packagist获取。根据项目设置,有多种方式可通过Composer安装。

作为插件使用

使用composer/installers将Blockstudio直接安装到你的wp-content/plugins/目录。这是由Composer管理的WordPress项目(如Bedrock)的标准做法。

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

通过WordPress管理后台或WP-CLI启用Blockstudio:

命令行
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设置就能提前引入此程序包,而不会在WordPress插件 API 就绪前启动Blockstudio。

作为必须启用的插件使用

将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只会自动加载mu-plugins/根目录中的PHP文件,不会加载子目录中的文件。添加一个加载器文件:

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提供程序包的自定义部署,请在Composer加载Blockstudio之前定义BLOCKSTUDIO_URL。请包含末尾斜杠:

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

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

也可以在加载Composer自动加载器之前注册blockstudio/url:

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)会捆绑在插件内并使用命名空间。安装到你的vendor/目录中的唯一Composer依赖项是yahnis-elsts/plugin-update-checker,它会在内部处理版本冲突。

代码
composer.json requires:
  php >= 8.2
  yahnis-elsts/plugin-update-checker ^5.6

更新

Composer安装会通过Composer接收更新。当Blockstudio从vendor/目录加载时,内置的GitHub更新程序会自动禁用。