Créer une catégorie pour les blocs Gutenberg

La catégorie des blocs dans Gutenberg est une fonctionnalité permettant d’organiser et de regrouper les différents blocs disponibles dans l’éditeur de blocs WordPress. Elle offre une structure logique et intuitive pour les utilisateurs lorsqu’ils recherchent et sélectionnent des blocs pour construire leurs pages ou leurs articles.

Pourquoi créer une nouvelle catégorie ?

Créer une nouvelle catégorie pour les blocs Gutenberg dans WordPress peut être intéressant pour plusieurs raisons :

Organisation : Avoir des catégories spécifiques pour vos blocs permet de mieux organiser l’éditeur Gutenberg. Cela facilite la recherche de blocs pertinents, surtout si vous avez un grand nombre de blocs personnalisés.
Clarté : En créant des catégories spécifiques, vous pouvez donner un sens plus clair à la finalité de chaque bloc, aidant ainsi les utilisateurs à comprendre rapidement l’utilité de chaque bloc disponible.
Personnalisation : Si vous développez des blocs pour un thème ou un plugin spécifique, les regrouper dans une catégorie personnalisée rend l’interface utilisateur plus cohérente et alignée avec le thème ou la fonctionnalité du plugin.

Catégories de blocs par défaut

Gutenberg propose une série de catégories par défaut pour organiser les blocs disponibles. Ces catégories offrent une structure de base pour classer les blocs en fonction de leur utilisation et de leur type de contenu. Voici quelques-unes des catégories par défaut les plus courantes :

Texte
Les blocs de la catégorie Texte sont utilisés pour l’ajout et la mise en forme de contenu textuel. On y trouve des blocs de paragraphe, de titre, de liste, de citation, etc., qui permettent de composer et de styliser le texte de manière efficace.
Média
La catégorie Média regroupe les blocs qui permettent d’ajouter et de manipuler des médias tels que des images, des galeries, des vidéos et des fichiers audio. Ces blocs offrent une manière simple et intuitive d’intégrer différents types de médias dans le contenu.
Design
Cette catégorie regroupe les blocs qui permettent de structurer la mise en page d’une page ou d’un article. On y trouve généralement des blocs de colonnes, de groupes et de conteneurs qui facilitent la création de mises en page complexes.
Widgets
Les blocs de la catégorie Widgets sont souvent utilisés pour ajouter des éléments interactifs ou dynamiques à une page ou un article. On y trouve des blocs comme les boutons, les formulaires de contact, les compteurs, les icônes, etc., qui permettent d’enrichir l’expérience utilisateur.
Thème
Cette catégorie regroupe les blocs spécifiques à un thème WordPress donné. Ces blocs sont conçus pour fonctionner de manière optimale avec le thème actif sur le site WordPress, offrant ainsi une cohérence visuelle et fonctionnelle dans la conception de la mise en page.
Contenu embarqué
Cette catégorie regroupe les blocs qui permettent d’intégrer du contenu provenant de sources externes telles que les réseaux sociaux, les plateformes de vidéo et les services de cartographie. On y trouve des blocs pour intégrer des tweets, des vidéos YouTube, des cartes Google Maps, etc.

Ajouter la catégorie en PHP

Pour créer une nouvelle catégorie de blocs Gutenberg, vous devez utiliser le filtre block_categories (ou block_categories_all pour les versions plus récentes de WordPress) dans votre fichier de plugin ou de thème. Voici un exemple de code pour ajouter une nouvelle catégorie :

PHP

function my_custom_block_categories($categories, $post) {
  return array_merge(
      $categories,
      array(
          array(
              'slug' => 'my-custom-category',
              'title' => __('My Custom Category', 'text-domain'),
              'icon'  => 'star-filled', // Nom de l'icône Dashicon (facultatif)
          ),
      )
  );
}

if ( version_compare( get_bloginfo( 'version' ), '5.8', '>=' ) ) {
	add_filter( 'block_categories_all', 'my_custom_block_categories' );
} else {
	add_filter( 'block_categories', 'my_custom_block_categories' );
}

Lorsque vous enregistrez vos blocs, vous pouvez les assigner à la nouvelle catégorie en spécifiant la catégorie dans l’objet de configuration du bloc.

Explication du code

Filtre block_categories_all (anciennement block_categories) : Ce filtre permet de modifier ou d’ajouter des catégories de blocs dans l’éditeur Gutenberg. Il prend deux arguments : les catégories existantes et le post en cours.
Fonction my_custom_block_categories : Cette fonction ajoute une nouvelle catégorie à la liste des catégories existantes. La nouvelle catégorie a un slug, un titre et une icône optionnelle.
Enregistrement du bloc : Lorsque vous enregistrez un nouveau bloc avec registerBlockType, vous spécifiez la catégorie en utilisant le slug de la catégorie personnalisée.

En suivant ces étapes, vous pouvez créer une nouvelle catégorie pour vos blocs Gutenberg, ce qui améliore l’organisation et l’expérience utilisateur dans l’éditeur.