Comment améliorer le module Metatag Schema.org dans Drupal avec des champs personnalisés

Introduction

Schema.org est un système conçu pour améliorer la façon dont les moteurs de recherche interprètent le contenu de votre site Web. Le Balises méta Schema.org Le module Drupal simplifie le processus d’incorporation de ces informations, améliorant ainsi le classement de votre site dans les moteurs de recherche et augmentant la probabilité d’afficher des extraits riches et informatifs dans les résultats de recherche.

Dans ce blog, nous explorerons étape par étape comment développer le module Metatags de Schema.org. Cela nous permettra de personnaliser et d’utiliser le module pour répondre à des besoins spécifiques qui ne sont pas couverts par ses paramètres par défaut.

Pour une introduction à l’utilisation du module Schema.org, vous pouvez vous référer à notre précédent blog «Améliorez la visibilité de votre site Drupal avec le balisage de schéma« . Cela fournira une compréhension fondamentale de la façon de mettre en œuvre efficacement le balisage Schema.org.

Cas d’utilisation

Pour commencer la mise en œuvre, il est important de comprendre pourquoi la création de champs personnalisés dans le module Drupal Schema.org Metatags est nécessaire. Le module est livré avec des schémas prédéfinis contenant des champs et des propriétés par défaut pour des types de schéma spécifiques. Cependant, il arrive souvent que des champs supplémentaires soient nécessaires et ne soient pas disponibles dans les schémas par défaut du module. Dans de telles situations, les champs personnalisés nous permettent d’ajouter les métadonnées requises aux groupes de schémas existants, garantissant ainsi que notre contenu répond à la fois aux normes Schema.org et aux besoins spécifiques du projet.

Implémenter des champs personnalisés dans les balises méta Schema.org de Drupal

Commençons par créer et ajouter des champs personnalisés dans le module Metatags Schema.org de Drupal.

Conditions préalables

Pour procéder à la mise en œuvre, assurez-vous que les conditions préalables suivantes sont remplies :

1. Module de balises méta Schema.org : Assurez-vous que le module Schema.org Metatags est installé et que sa version est supérieure à 3.0.0.
2. Module personnalisé : Assurez-vous de disposer d’un module personnalisé existant auquel vous pouvez ajouter la balise méta. Si un module personnalisé n’existe pas, créez-en un

Avant de commencer la mise en œuvre, examinez l’instantané actuel du schéma organisationnel sans aucun champ personnalisé incorporé :

Schéma d’organisation sans champ personnalisé

Étape 1 : Définir le plugin de balise méta

Pour définir votre balise méta personnalisée, créez une classe PHP dans votre module personnalisé sous le répertoire custom_module/src/Plugin/metatag/Tag.

• Accédez à /modules/custom/custom_module/src/Plugin/metatag/Tag.
• Créez un nouveau fichier nommé CustomField.php. (Le nom de la classe peut être n’importe quoi selon les exigences).
  

  Structure des dossiers de champs personnalisés
• Définissez votre balise méta avec des annotations comme indiqué ci-dessous :

  <?php
  
  namespace Drupal\custom_module\Plugin\metatag\Tag;
  
  use Drupal\schema_metatag\Plugin\metatag\Tag\SchemaNameBase;
  
  /**
  * Provides a plugin for the 'custom_field' meta tag.
  *
  * @MetatagTag(
  * id = "custom_field",
  * label = @Translation("Custom Field"),
  * description = @Translation("A custom field for demo purposes."),
  * name = "custom_field",
  * group = "schema_organization",
  * weight = 1,
  * type = "string",
  * secure = FALSE,
  * multiple = FALSE,
  * property_type = "text",
  * tree_parent = {},
  * tree_depth = -1,
  * )
  */
  class CustomField extends SchemaNameBase {
  }

  Remarque : Ici, nous avons utilisé schema_organization en tant que groupe, tout autre groupe peut être utilisé selon les besoins.

Étape 2 : déclarer le champ dans la configuration

Pour rendre disponible votre nouvelle balise méta, déclarez-la dans la configuration de votre module.

• Créez un répertoire ‘config/’ dans votre module personnalisé s’il n’existe pas déjà.
• Ajoutez un fichier de configuration pour votre balise méta. Par exemple, créez un fichier nommé custom_module.metatag_tag.schema.yml dans le répertoire config/ :
  

  structure des dossiers du fichier de configuration

• Déclarez le champ avec le type et l’étiquette correspondant :

  # The 'type' should be "label" for short meta tags and "text" for ones which
  # could get longer, especially ones which use a textarea field instead of a
  # textfield.
  metatag.metatag_tag.custom_field:
  type: string
  label: 'Custom Field'

Étape 3 : Testez votre champ personnalisé

• Accédez à /admin/config/search/metatag.
• Ici, nous allons vérifier la balise méta Global dans le schéma d’organisation, car nous avons ajouté le nouveau champ personnalisé.
  

  Ajout de champs personnalisés au schéma de type d’organisation

• Après avoir ajouté le champ personnalisé au schéma du type d’organisation, le résultat final doit ressembler à l’instantané suivant :
  

  Ajout de champs personnalisés

Conclusion

En suivant ces étapes, vous avez réussi à étendre le module schema_metatag pour inclure une balise méta personnalisée dans votre module Drupal existant. Cette approche peut être adaptée à différents types de métadonnées, améliorant ainsi le référencement et la gestion des métadonnées de votre site Drupal. Pour plus d’informations sur le module Drupal de balise méta de schéma, vous pouvez également vous référer au documentation officielle du module.