Gå til indhold

Composer

Blockstudio fås på Packagist. Der er flere måder at installere det på via Composer, afhængigt af projektets opsætning.

Som plugin

Brug composer/installers til at installere Blockstudio direkte i din wp-content/plugins/-mappe. Dette er standardmetoden til Composer-administrerede WordPress-projekter som Bedrock.

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

Aktivér Blockstudio via WordPress-administrationen eller WP-CLI:

Shell
wp plugin activate blockstudio

Projektets autoloader Composer skal indlæses af appen WordPress, så Composer kan registrere Blockstudio. I Bedrock håndteres dette automatisk. I andre opsætninger skal du bruge et must-use-plugin:

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

Når Blockstudio inkluderes via autoloaderen Composer, før WordPress er begyndt at indlæse plugins, udsætter opstartsprocessen Composer initialiseringen, indtil plugin-indlæsningsmiljøet er tilgængeligt. Dermed kan Bedrock og andre Composer-opsætninger på webstedsniveau inkludere pakken tidligt uden at starte Blockstudio, før API’erne for plugins i WordPress er klar.

Som must-use-plugin

Installér Blockstudio i mu-plugins/, så det indlæses automatisk uden aktivering. Tilsidesæt installationsstien, så den peger på mappen mu-plugins:

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

WordPress indlæser automatisk kun PHP-filer i roden af mu-plugins/, ikke i undermapper. Tilføj en indlæsningsfil:

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

Aktivering er ikke nødvendig. Blockstudio indlæses automatisk ved hver anmodning.

Samlet i et tema

Installér Blockstudio som en afhængighed i dit tema. Så er alt samlet ét sted, og du behøver ikke et separat plugin.

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

Indlæs det i dit temas functions.php:

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

Blockstudio startes automatisk via autoloaderen Composer, når den indlæses af WordPress. URL’er til aktiver peger på den korrekte temamappe. Blokke, der er defineret i mappen blockstudio/ i dit tema, fungerer præcis som ved en plugininstallation. Dette virker også, når den offentlige temamappe er et symlink: Blockstudio mapper pakkens fysiske sti gennem det aktive tema eller overordnet tema URL i stedet for at afsløre serverstien.

Samlet i et plugin

Installér Blockstudio som en afhængighed i et andet plugin. Den samme autoloaderbaserede opstartsproces gælder.

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

Indlæs det i dit plugins hovedfil:

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

URL’er til aktiver peger på den korrekte vendor-mappe for plugin’et.

Kontrol af understøttede indlæsningstilstande

Blockstudio kontrollerer løbende den samme pakke i fire understøttede runtime-positioner:

Tilstand Bootstrap
WordPress-plugin WordPress aktiverer blockstudio.php
Must-use-plugin En loader i roden kræver pakkens indgangspunkt
Composer-afhængighed i et tema Temaet kræver autoloaderen Composer
Composer-afhængighed i et plugin Værtsplugin’et kræver autoloaderen Composer

Hver tilstand starter WordPress med samme resultat: én Blockstudio-instans med BLOCKSTUDIO_VERSION defineret og uden et ekstra værtsabstraktionslag nedenunder.

Brugerdefineret pakke-URL

Installationer som almindeligt plugin, must-use-plugin, samlet plugin, aktivt tema, overordnet tema og tema med symlink finder automatisk den rette placering. Ved en brugerdefineret implementering, hvor pakken eksponeres via en anden offentlig URL, skal du definere BLOCKSTUDIO_URL, før Composer indlæser Blockstudio. Medtag den afsluttende skråstreg:

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

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

Du kan i stedet registrere blockstudio/url, før du indlæser autoloaderen 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';

Filteret modtager den løste URL og pakkens fysiske mappe.

Afhængigheder

Runtime-afhængighederne for Blockstudio (TailwindPHP, ScssPhp, Minify) er samlet og navnerumssikret i plugin’et. Den eneste afhængighed af typen Composer, der installeres i din vendor/-mappe, er yahnis-elsts/plugin-update-checker, som håndterer versionskonflikter internt.

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

Opdateringer

Installationer af Composer modtager opdateringer via Composer. Den indbyggede opdateringsfunktion GitHub deaktiveres automatisk, når Blockstudio indlæses fra en vendor/-mappe.