Aller au contenu

Remplacements

Blockstudio permet de remplacer des blocs de manière très précise. Cela peut s’avérer utile pour les bibliothèques de blocs partagées lorsque vous souhaitez modifier le comportement d’un bloc sans avoir à en créer un nouveau de toutes pièces.

block.json

Pour commencer, définissez le nom du bloc à remplacer comme clé name, puis définissez la clé override sur true.

JSON
{
  "name": "blockstudio/my-block",
  "title": "My overridden block title",
  "blockstudio": {
    "override": true
  }
}

Lorsque la propriété override est définie sur true, les données du nouveau block.json sont fusionnées avec celles du bloc d’origine. Vous pouvez ainsi remplacer n’importe quelle propriété du bloc d’origine.

Attributs

Les attributs peuvent être remplacés par id ou ajoutés. Par exemple, imaginons que nous voulions remplacer l’attribut width d’un bloc et ajouter un nouvel attribut height.

JSON
{
  "name": "blockstudio/my-block",
  "title": "My overridden block title",
  "blockstudio": {
    "override": true,
    "attributes": [
      {
        "id": "width",
        "type": "number",
        "default": 280,
        "label": "Override width"
      },
      {
        "id": "height",
        "type": "number",
        "default": 280,
        "label": "New height"
      }
    ]
  }
}

Lorsqu’un attribut portant le même id est trouvé, ses données sont fusionnées avec celles de l’attribut d’origine. Les attributs introuvables sont ajoutés au bloc.

Avertissement

Lorsque vous remplacez des attributs, vous devez fournir le type de l’attribut d’origine, même s’il reste identique.

Structures complexes

Lorsque vous remplacez des attributs aux structures complexes (champs répéteurs, groupes, onglets, etc.), vous devez fournir toute la structure de l’attribut jusqu’à l’élément à remplacer.

JSON
{
  "name": "blockstudio/my-block",
  "blockstudio": {
    "override": true,
    "attributes": [
      {
        "id": "tabs",
        "type": "tabs",
        "tabs": [
          {
            "id": "tab1",
            "attributes": [
              {
                "key": "group1",
                "type": "group",
                "title": "Group",
                "attributes": [
                  {
                    "id": "text",
                    "type": "text",
                    "label": "Override text"
                  }
                ]
              }
            ]
          },
          {
            "id": "tab2",
            "title": "Override tab",
            "attributes": [
              {
                "id": "group",
                "type": "group",
                "title": "Group ID",
                "attributes": [
                  {
                    "id": "text",
                    "type": "text",
                    "label": "Override text"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Ressources

Les fichiers de ressources sont remplacés lorsque leur nom correspond. Par exemple, si le fichier style.css existe dans le bloc d’origine, il sera remplacé par le fichier style.css du bloc de remplacement. Les fichiers dont le nom ne correspond pas à celui d’un fichier du bloc d’origine sont ajoutés au bloc.

Modèle de rendu

Vous pouvez remplacer les modèles de rendu en fournissant un nouveau fichier de modèle : index.php, index.twig ou index.blade.php.

Blocs Twig

Les modèles Twig peuvent être remplacés avec plus de précision à l’aide de la fonctionnalité block dans Twig.

Imaginons le modèle de rendu suivant pour un bloc image fictif :

Twig
<h1>Images:</h1>
{% for image in a.images %}
  <div class="content">
    {% block image %}
      <img src="{{ image.url }}" class="image" />
    {% endblock %}
  </div>
{% endfor %}

Au lieu de remplacer le modèle entier, nous pouvons utiliser la fonctionnalité extends de Twig pour en remplacer certaines parties tout en conservant le reste.

Twig
{% extends 'index.twig' %}

{% block image %}
  <figure>
    <img src="{{ image.url }}" class="image" />
    <figcaption>{{ image.caption }}</figcaption>
  </figure>
{% endblock %}