Aller au contenu

Composer

Blockstudio est disponible sur Packagist. Il existe plusieurs façons de l’installer avec Composer selon la configuration de votre projet.

En tant que plugin

Utilisez composer/installers pour installer Blockstudio directement dans le répertoire wp-content/plugins/. C’est l’approche standard pour les projets WordPress gérés par Composer, comme Bedrock.

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

Activez Blockstudio depuis l’administration WordPress ou avec WP-CLI :

Shell
wp plugin activate blockstudio

L’autoloader Composer de votre projet doit être chargé par l’application WordPress afin que Composer puisse enregistrer Blockstudio. Dans Bedrock, cela est géré automatiquement. Dans les autres configurations, utilisez un plugin obligatoire :

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

Lorsque Blockstudio est inclus via l’autoloader de Composer avant que WordPress ne commence à charger les plugins, l’initialisation de Composer est différée jusqu’à ce que l’environnement de chargement des plugins soit disponible. Ainsi, Bedrock et les autres configurations Composer au niveau du site peuvent inclure le paquet tôt sans démarrer Blockstudio avant que les API de plugin WordPress soient prêtes.

En tant que plugin obligatoire

Installez Blockstudio dans mu-plugins/ pour qu’il se charge automatiquement sans activation. Remplacez le chemin d’installation pour cibler le répertoire mu-plugins :

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

WordPress charge automatiquement uniquement les fichiers PHP à la racine de mu-plugins/, pas dans les sous-répertoires. Ajoutez un fichier chargeur :

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

Aucune activation n’est nécessaire. Blockstudio se charge automatiquement à chaque requête.

Intégration à un thème

Installez Blockstudio comme dépendance de votre thème. Tout reste ainsi autonome, sans nécessiter de plugin séparé.

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

Chargez-le dans le fichier functions.php de votre thème :

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

Blockstudio s’initialise automatiquement via l’autoloader de Composer lorsqu’il est chargé par WordPress. Les URL des ressources pointent vers le bon répertoire du thème. Les blocs définis dans le dossier blockstudio/ de votre thème fonctionnent exactement comme avec une installation en plugin. Cela fonctionne aussi lorsque le répertoire public du thème est un lien symbolique : Blockstudio résout le chemin physique du paquet via l’URL du thème actif ou parent, au lieu d’exposer le chemin du serveur.

Intégration à un plugin

Installez Blockstudio comme dépendance d’un autre plugin. Le même mécanisme d’initialisation par autoloader s’applique.

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

Chargez-le dans le fichier principal de votre plugin :

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

Les URL des ressources pointent vers le bon répertoire vendor du plugin.

Vérifications des modes de chargement pris en charge

Blockstudio vérifie en continu le même paquet dans quatre positions d’exécution prises en charge :

Mode Bootstrap
Plugin WordPress WordPress active blockstudio.php
Plugin obligatoire Un chargeur à la racine requiert le point d’entrée du paquet
Dépendance Composer dans un thème Le thème requiert l’autoloader de Composer
Dépendance Composer dans un plugin Le plugin hôte requiert l’autoloader de Composer

Chaque mode initialise WordPress de la même façon : une instance Blockstudio, avec BLOCKSTUDIO_VERSION défini et aucune seconde abstraction hôte sous-jacente.

URL du paquet personnalisé

Les installations comme plugin classique, plugin obligatoire, plugin intégré, thème actif, thème parent ou thème lié symboliquement sont résolues automatiquement. Pour un déploiement personnalisé où le paquet est exposé via un autre URL public, définissez BLOCKSTUDIO_URL avant que Composer ne charge Blockstudio. Incluez la barre oblique finale :

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

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

Vous pouvez aussi enregistrer blockstudio/url avant de charger l’autoloader 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';

Le filtre reçoit le URL résolu et le répertoire physique du paquet.

Dépendances

Les dépendances d’exécution de Blockstudio (TailwindPHP, ScssPhp, Minify) sont intégrées et leurs espaces de noms sont isolés dans le plugin. La seule dépendance Composer installée dans votre répertoire vendor/ est yahnis-elsts/plugin-update-checker, qui gère en interne la résolution des conflits de versions.

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

Mises à jour

Les installations Composer reçoivent les mises à jour via Composer. Le programme de mise à jour intégré GitHub est désactivé automatiquement lorsque Blockstudio est chargé depuis un répertoire vendor/.