Pular para o conteúdo

Composer

Blockstudio está disponível em Packagist. Há várias maneiras de instalá-lo via Composer, dependendo da configuração do seu projeto.

Como plugin

Use composer/installers para instalar Blockstudio diretamente no diretório wp-content/plugins/. Esta é a abordagem padrão para projetos WordPress gerenciados por Composer, como Bedrock.

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

Ative Blockstudio pelo painel administrativo de WordPress ou por WP-CLI:

Shell
wp plugin activate blockstudio

O autoloader Composer do seu projeto deve ser carregado pelo aplicativo WordPress para que Composer possa registrar Blockstudio. Em Bedrock, isso é feito automaticamente. Em outras configurações, use um plugin de uso obrigatório:

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

Quando Blockstudio é incluído pelo autoloader de Composer antes de WordPress começar a carregar plugins, o bootstrap de Composer adia a inicialização até que o ambiente de carregamento de plugins esteja disponível. Isso permite que Bedrock e outras configurações Composer no nível do site incluam o pacote antecipadamente, sem inicializar Blockstudio antes que as APIs de plugins de WordPress estejam prontas.

Como plugin de uso obrigatório

Instale Blockstudio em mu-plugins/ para que ele carregue automaticamente, sem ativação. Substitua o caminho do instalador para apontar ao diretório de mu-plugins:

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

WordPress carrega automaticamente apenas arquivos PHP na raiz de mu-plugins/, e não em subdiretórios. Adicione um arquivo carregador:

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

Não é necessária ativação. Blockstudio é carregado automaticamente em todas as solicitações.

Incluído em um tema

Instale Blockstudio como dependência dentro do seu tema. Assim, tudo fica autocontido, sem exigir um plugin separado.

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

Carregue-o no arquivo functions.php do seu tema:

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

Blockstudio é inicializado automaticamente pelo autoloader de Composer quando é carregado por WordPress. As URLs dos recursos apontam para o diretório correto do tema. Os blocos definidos na pasta blockstudio/ do seu tema funcionam exatamente como em uma instalação por plugin. Isso também funciona quando o diretório público do tema é um link simbólico: Blockstudio mapeia o caminho físico do pacote pelo URL do tema ativo ou do tema pai, em vez de expor o caminho do servidor.

Incluído em um plugin

Instale Blockstudio como dependência dentro de outro plugin. O mesmo bootstrap de carregamento automático se aplica.

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

Carregue-o no arquivo principal do seu plugin:

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

As URLs dos recursos apontam para o diretório vendor correto do plugin.

Verificações dos modos de carregamento compatíveis

Blockstudio verifica continuamente o mesmo pacote em quatro posições de runtime compatíveis:

Modo Bootstrap
Plugin WordPress WordPress ativa blockstudio.php
Plugin de uso obrigatório Um carregador na raiz exige o ponto de entrada do pacote
Dependência Composer em um tema O tema exige o autoloader de Composer
Dependência Composer em um plugin O plugin hospedeiro exige o autoloader de Composer

Todos os modos inicializam WordPress com o mesmo resultado: uma instância de Blockstudio com BLOCKSTUDIO_VERSION definido e sem outra abstração hospedeira por baixo.

URL de pacote personalizado

Instalações como plugin normal, plugin de uso obrigatório, plugin incluído, tema ativo, tema pai e tema com link simbólico são resolvidas automaticamente. Para uma implantação personalizada em que o pacote é exposto por outro URL público, defina BLOCKSTUDIO_URL antes que Composer carregue Blockstudio. Inclua a barra final:

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

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

Você também pode registrar blockstudio/url antes de carregar o autoloader de 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';

O filtro recebe o URL resolvido e o diretório físico do pacote.

Dependências

As dependências de runtime de Blockstudio (TailwindPHP, ScssPhp, Minify) estão incluídas e com namespaces próprios no plugin. A única dependência Composer instalada no seu diretório vendor/ é yahnis-elsts/plugin-update-checker, que gerencia internamente a resolução de conflitos de versão.

Código
composer.json requires:
  php >= 8.2
  yahnis-elsts/plugin-update-checker ^5.6

Atualizações

Instalações de Composer recebem atualizações por Composer. O atualizador GitHub integrado é desativado automaticamente quando Blockstudio é carregado de um diretório vendor/.