Drupal

Via la commande drush generate form:simple, il est très facile de générer le squelette pour un formulaire, avec une route liée. 

Dans le cas d'une migration, un plugin très pratique permet de retrouver une référence avec son nouvel id.

Petit état de l'art de la batch API dans drupal 10. 

Très complet. En anglais.

Voici comment ajouter un ou plusieurs champs au formulaire de configuration « paramètres de base du site ».

On commence par créer un service qui nous permettra de surcharger le formulaire de base : 

modules/mon_module/mon_module.services: 

Version actualisée de Drupal 8 - Créer un Event, le lancer et l'intercepter pour drupal 10+

Les raisons peuvent être diverses, mais parfois on veut que certaines tables soient dans une base de données spécifique au lieu de la principale. 

Dans mon cas c'est lors d'un déploiement « bleu / vert ». 

En anglais, une bonne ressource pour créer son premier service avec Drupal.

Une fois le principe compris, il existe aussi la commande 

drush generate service:custom

Parfois cela peut dépanner d'aller modifier directement une clé de config depuis son terminal.

C'est là que drush avec la commande config:edit (alias : cedit) vient à la rescousse.

Car à chaque fois je perds quelques minutes à retrouver ça : 

{{ url('mon_module.ma_route', [], {'fragment': 'mon-ancre'}) }}

Voici comment écrire directement dans un Bucket Google Cloud Storage depuis un script drupal (ou une migration) via le module flysystem_gcs.

Ici une POC via un script drush : 

Voici comment scanner un dossier récursivement et récupérer tableau de fichiers correspondant à une expression régulière :

ici je récupère tous les fichiers .xml dans le dossier private://sms

Les liens d'opérations sont les liens contenus dans le menu déroulant sur les listing dans drupal

Dans drupal 9, via la librairie jquery UI Dialog, Il est possible très facilement d'ouvrir des pages dans des fenêtres modales (ou « popin », « Lightbox »...) Dans votre contrôleur :

Drupal propose un mécanisme en backoffice pour contrôler l'affichage des blocs, mais il est nécessaire parfois de mettre en place une logique un peu plus complexe.

    $fields['related_content'] = BaseFieldDefinition::create('string_long')
      ->setLabel(t('Related content'))
      ->setSetting('text_processing', FALSE)
      ->setDisplayConfigurable('form', TRUE)
      ->setTranslatable(FALSE);

&

Depuis un controller :

Voici comment depuis la soumission d'un formulaire déclencher le téléchargement d'un fichier via une BinaryFileResponse :

Voici comment rediriger un utilisateur après la création ou la modification d'un noeud

Voici comment, via un script où une fonction d'update, supprimer des clés de configuration dans la base de données :

DDEV est une couche d'abstraction à docker et docker-compose permettant de mettre en place une infrastructure pour développer simplement sur un projet drupal sans avoir à installer php, mysql... et autre sur sa machine.

Voici comment importer via un script où une fonction d'update un ou plusieurs fichiers de config :

Si vous avez créé un champ personnalisé dans drupal, associé en tant que champs, ou basefield à un type d'entité et que vous souhaitez le changer (ajouter un attribut par exemple cela peut s'avérer assez compliqué, surtout si votre champs à plusieurs instances dans différents types d'entités.

Devel Generate est un sous module de Devel permettant de générer du contenu de test pour son site drupal, que cela soit des nœuds, des termes de taxonomy, des utilisateurs ou encore des éléments de menu.

Il est parfois nécessaire d'importer de la config directement dans un HOOK_update().

Via le module core « telephone », il est possible de créer un champ de base (basefield) pour les numéros de téléphone. Rien de foufou au niveau de la validation, c'est uniquement au niveau de l'affichage que ce champ permettra d'afficher le numéro sous forme de lien.

Aujourd'hui dans le genre pourquoi faire simple quand on peut faire compliqué, nous allons voir comment rajouter une balise meta dans le code source de nos pages de notre site Drupal 8.

Pour un projet, je souhaiter alterer un type d'entité via HOOK_entity_type_alter. Problème un module du core effectuait une modification sur ce même type d'entité, et son hook était exécuté après celui de mon module.

Note : Il est aussi possible de créer des éléments de menu dans le fichier MODULE.links.menu.yml, cf : https://kgaut.net/snippets/2017/drupal-8-creer-un-element-de-menu-vers-… et

Gin est mon thème backoffice coup de coeur de ces derniers mois, il donne un coup de fouet au backoffice de drupal !

Il est possible dans drupal 8 et 9 de surcharger l'auto-completion d'un champ « référence à un type d'entité », à la fois la requête générée (pour par exemple faire la recherche sur d'autres champs que le titre, mais aussi le label des éléments retournés.

Voici comment ajouter un basefield slug à un type d'entité client. La définition de cette propriété se trouvant dans la méthode baseFieldDefinitions de notre type d'entité :

À la différence d'une propriété « lien » (voir :

Je me suis rendu compte que je n'avais jamais documenté comment ajouter une propriété « référence à une entité » :

Pour un type d'entité « client » :

Phpcs (ou PHP Code Sniffer) est un inspecteur de code permettant de vérifier la validité du code écrits en fonction de standards.

Pour  l'ajouter à notre projet drupal géré via composer :

Dans le contexte d'un webform, je voulais pouvoir envoyer une notification à un email en particulier en fonction du sujet du message de contact.

Voici comment installer un type d'entité personnalisé via un hook_update.

À noter, les types d'entités d'un module sont automatiquement installés lors de l'installation du module. Ce snippet n'est utile que pour un type d'entité créé à postériori.

Voici comment définir une propriété (basefield) « e-mail » sur un type d'entité.

Il est possible dans un contrôleur ou un bloc de récupérer un formulaire et de l'afficher comme n'importe quelle autre variable.

 Voila comment ajouter une propriétée faisant référence à un média sur un type d'entité :

Dans la continuité de Drupal 8 & Drupal 9 - Views - créer un Pager personnalisé.

Pour un projet j'avais besoin d'afficher une pagination particulière sur une vue.

La première page devait afficher 9 éléments, et les suivantes 12.

J'ai donc pour cela créé un Pager personnalisé pour Views, et ajouté ce paramètre en option.

Depuis quelques jours, on peut rencontrer l'erreur «  undefined index: extra » lors d'un composer update ou composer require.

Si vous rencontrez ce soucis, exécutez la commande :

VIa le module media_library_form_element, Voici comment ajouter un champ de type « référence à un media » dans un formulaire personnalisé en utilisant le widget Media Library :

Dans le fichier mon_module.links.menu.yml, on peut facilement placer un élément de menu dans une arborescence via la clé parent.

À partir de drupal 8, c'est une vue qui gère la page des contenus d'un terme de taxonomie.

Le soucis est que c'est la même vue pour l'ensemble des vocabulaires.

Voici comment créer une archive zip et y ajouter des fichiers.

Pour commencer, nous aurons besoin d'injecter deux services, (ici je suis dans un formulaire, à adapter en fonction du contexte)

Petite découverte datant d'il y a quelques mois, il est possible via une EntityQuery d'ajouter une condition sur un champ d'une entité liée.

Petit exemple :

Voici un exemple rapide de commande drush appelant une méthode d'un service avec une option lors de l'appel.

Voici comment inclure des fichiers CSS ou JS sur une page contenant une vue.

Pour rappel les librairies peuvent être définies dans un thème ou un module.

Dans le cadre d'une EntityQuery, il peut être nécessaire parfois de faire une requête sur une colonne spécifique de notre table, autre que le traditionnel « value ».

Rien de bien compliqué, il faut alors le spécifier dans le nom du champ sur lequel on ajoute une condition.

Pour un projet drupal, j'avais besoin de créer deux tables identiques dans une base de données séparée sur un serveur différent, afin de servir de cache pour un webservice.

Voici comment modifier un onglet Local Task dans le langage drupal, en utilisant le hook HOOK_local_tasks_alter:

La seconde version beta de Drupal 9 est sortie il y a quelques jours, et la version stable est prévue pour le 3 juin.

Les contextual filters ou filtres contextuels sont une fonctionnalité très utile du module views de drupal : il permettent, comme le nom l'indique de filtrer les éléments affichés en fonction d'un paramètre contextuel (lié à un

Sous Drupal 8 il est possible de surcharger la classe du type d'entité « User » afin de par exemple ajouter nos propres getters et setters ou de modifier l'affichage par défaut d'un nom d'utilisateur.

La page par défaut de liste des termes de taxonomie de drupal 8 n'est pas très flexible. Elle peut facilement être substituée à une vue mais dans ce cas on perd le « drag'n'drop » dans le cas d'une arborescence.

Voici comment ajouter des suggestions de template à un type d'entité personnalisé en fonction du mode d'affichage (view_mode).

Ici mon module s’appelle « mon_module » et mon type d'entité personnalisé « resource » :

Voici comment ajouter une classe css à un élément de menu défini dans un module.

mon_module.links.menu.yml

Voici comment supprimer le basefield « mon_champ_a_suppr » de mon type d'entité personnalisé « mon_type_entite ».

Pour un type d'entité personnalisé, les alias peuvent se gérer à l'aide de motifs via le module pathauto.

Mais à l'instar des nœuds, parfois nous voulons pouvoir avoir la main sur l'alias directement.

Sur un site drupal 8, j'ai pour habitude de créer un élément de menu spécifique dans la barre d'administration qui comprend toutes les parties un peu métier du site.

Sur des projets j'ai depuis quelques jours, lors d'un composer install, l'erreur suivante arrive :

Package type "drupal-console-library" is not supported

Sur une commande expresse de Vincent, voici comment modifier les formulaires de création / modification de nœud pour être redirigé sur la page de listing des nœuds plutôt que sur le nœud en lui même lors de la création ou de la modification d'un contenu.

Voici comment attacher une librairie javascript ou un fichier css à un module custom dans drupal 8.

Dans les extraits de code ci-dessous, le nom machine du module sera « shoutbox ».

Sous drupal 8, les types d'entités, comme les noeuds, viennent avec leur classe pour gérer le contrôle d'accès (création / modification / visualisation / suppression).

Il est possible de surcharger ces classes pour personnaliser plus finement ce contrôle.

Dans le cas d'une page dé-publiée, si en tant qu'anonyme on tombe sur une erreur 403. On peut vouloir rediriger cette page temporairement vers une autre via le module redirect, mais nativement ça n'est pas pris en compte.

Hier, nous avons vu comment surcharger le formulaire de création / modification d'un nœud, voici aujourd'hui comment faire la même chose mais pour un terme de taxonomie.

Pour modifier le formulaire de création d'un nœud sous drupal 8, on peut utiliser le bon vieux HOOK_form_alter(), mais on peut aussi faire quelque chose de plus « propre » en altérant le type d'entité pour redéfinir son formulaire.

Cela se passe en deux étapes.

La form api de drupal est très puissante, mais pour jouer avec le markup html avec les #prefix et #suffix peut s'avérer rapidement complexe en plus d'être un peu sale au niveau du code.

Dans Drupal 8, le principe des hooks a été remplacé par un système d'évènement qui est lancé et peut être intercepté, cela se passe en 3 étapes :

Drupal tient un registre des versions des modules installés, ces versions correspondent au dernier numéro du hook_update exécuté du module.

Drupal 8 propose un système de cache très puissant et à plusieurs niveaux.

Ici nous allons voir comment stocker simplement le résultat d'une requête en cache afin de ne pas avoir à la lancer la requête SQL à chaque appel.

Il est possible via drush d’exécuter un script php et de profiter de toute l'API de drupal pour effectuer des traitements (création / suppression de contenu, modification, import de traductions...)

Outre la base de données « classique » de drupal, il est aussi possible de se connecter à une autre base de données.

Pour cela dans le fichier de settings il faut définir les identifiants :

Une petite dépendance à ajouter à son composer.json qui permet d'économiser pas mal de ram lors des taches lourdes de composer (update notamment)

Afficher la liste des destinations de migration :

drupal debug:plugin migrate.destination

Voici comment écrire un fichier dans drupal 8 :

Quand un template est appelé via un « reder array », le template va être cherché en priorité dans le thème actif, puis dans le module qui déclare ce template.

Voici comment ajouter un champ texte formaté avec résumé à un type d'entité :

(et oui des fois on doit retourner sous drupal 7)

Voici comment créer un champ calculé pour un type d'entité (ici Node) qui sera accessible comme n'importe quel champ dans views.

Dans mon_module.module :

À la demande d'un client je devais ajouter un attribut « target="_blank" » sur tous les liens sortant du site.

J'ai pour cela créé un filtre de texte que j'ai appliqué à un format de texte.

Voici le fichier mon_module/src/Plugin/Filter/UrlTargetBlankFilter.php

Dans mon_module.install :

Dans mon_module.install :

Voici comment altérer un type d'entité config pour lui ajouter une propriété.

Pour afficher avoir le renderable array d'un noeud dans le code, rien de plus simple via le service entity_type.manager :

Dans le contrôleur / Bloc...

Dans un processus de déploiement, il est utile de gérer les traductions de chaînes de caractères dans le code, afin de pouvoir les déployer plus facilement.

Exemple avec cette fonction d'update à adapter en fonction de vos besoins :

Dans le fichier MODULE.routing.yml on va utiliser le requirement « _custom_access »

Voici comment créer un champ « fichier » au sein d'un type d'entité custom dans drupal 8 :

Prenons deux types d'entités custom : « Bière » et « Brasserie » avec une relation 1-n entre les deux dans le sens :

• Une bière provient d'une et d'une seule brasserie
• Une brasserie peut proposer N bières

 Ainsi :

Voici comment créer un Menu item (élément de menu) avec des paramètres GET.

Le type nombre décimal peut-être pratique pour stocker tout nombre à virgule (un prix par exemple).

Voici comment attacher une propriété « nombre décimal » à un type d'entité personnalisé.

Voici comment générer un lien pour « flaguer » une entité avec drupal 8 et le module flag :

Pour récupérer et retourner un webform où l'on veut via le code (que ce soit dans un bloc, un controller...) on peut utiliser les lignes suivantes :

Voici comment récupérer le domaine actif quand on utilise le module Domain Access pour Drupal 8 :

Pour créer un champ de base de type lien, dans la définition de votre entité :

Voici comment créer une table dans une base de donnée autre que celle par défaut.

Code à mettre dans votre MODULE.install

Ça vient à contre-sens du paradigme des nœuds, mais parfois on souhaite que les pages de détail d'un nœud d'un type de contenu en particulier ne soient pas accessible.

Voici comment faire :

1ère étape, déclarer un services dans mon_module.services.yml

Pour un besoin spécifique, il fallait que je récupère un formulaire exposé de views pour l'afficher ailleurs.

Il fallait en fait qu'à un endroit j'affiche les filtres exposés et à un autre le tri exposé.

J'ai donc créé un bloc, qui récupère ce formulaire, masque un champ.

$fid = 5;
$file =  \Drupal\file\Entity\File::load($fid);
$url_fichier = $file->url();

Utile dans le cadre d'une vue affichant des résultats d'une recherche via Search API :

Parfois on se retrouve avec un gros White Screen Of Death sur son site, et impossible de se connecter.

Dans ce cas là il est pratique de pouvoir afficher en live le contenu du watchdog, c'est possible avec Drush et la commande watchdog-show :

Voici comment dans un formulaire custom D8, avoir un ensemble de champ "multiples" dans un formulaire de config par exemple.

Plus d'information sur les EntityQuery.

Récupérer $_GET['test'] :

$test = \Drupal::request()->query->get('test');

Récupérer $_POST['test'] :

$test = \Drupal::request()->request->get('test');

Récupérer un tabl

Sur ce site, j'ai trois types de contenu :

• Article
• Snippet
• Réalisation

Pour chacun de ces trois types de contenu, j'ai une vue (View) de listing qui correspond (cf le menu ci-dessus).

Pour rediriger un utilisateur lorsqu'il se connecte on peut utiliser le hook HOOK_user_login().

Le code qui suit ne redirige que si une redirection n'est pas déjà présente dans l'url :

Dans drupal 8, parfois le thème ajoute des suggestions de template qui vont bien, en fonction du type de noeud et du view_mode, mais ça n'est pas toujours le cas, voici comment faire pour ajouter des suggestions de template via le hook HOOK_theme_suggestions_HOOK() :

    $fields['date_naissance']  = BaseFieldDefinition::create('datetime')
      ->setLabel(t('Date de naissance'))
      ->setRequired(TRUE)
      ->setDefaultValue(NULL)
      ->setSetting('datetime_type', 'date')
      ->setDisplayOptions('form', arra

Drupal vient avec des types d'entité prédéfinis (Node, ou User par exemple). À ces type d'entité il est possible d'ajouter des fields, mais il est aussi possible d'ajouter des propriétés.

Voici comment ajouter des propriétés (prénom et nom) aux utilisateurs.

Dans le fichier monmodule.links.menu.yml :

monmodule.menu.cle:
  title: 'Titre de ma mage'
  description: 'Liste des options'
  route_name: view.admin_options.page
  parent: system.admin_content
  weight: 90

Quelques explications :

    $fields['photo'] = BaseFieldDefinition::create('image')
      ->setLabel(t('Photo'))
      ->setSetting('file_directory', 'formateurs/photos')
      ->setSetting('file_extensions', 'png jpg jpeg')
      ->setSetting('min_resolution', '400x400')
      

Contexte :

Pour faire un champ de base référence à un terme de taxonomie, on va utiliser le type "entity_reference", en lui passant évidement le nom du vocabulaire, (ici "option_types") :

Dans Drupal 8 la gestion des menus et des route à été complètement revue, le hook_menu_alter n'existe plus.

Pour créer un alias d'url dans le code, au sein d'une fonction d'update par exemple on appelle le service path.alias_storage :

Pour définir qu'une route doit utiliser le thème d'administration, il faut utiliser le fichier MON_MODULE.routing.yml.

Cela se fait en défininssant l'option _admin_route à TRUE.

Exemple :

// On charge l'entité que l'on veut flaguer
$user = User::load(1)

$flag_service = \Drupal::service('flag');
$id_du_flag = 'follow_user'; 
$flag = $flag_service->getFlagById($id_du_flag);
$flag_service->flag($flag, $user);

    $fields['photos_number'] = BaseFieldDefinition::create('list_integer')
      ->setLabel(t('Nombre de photos autorisées'))
      ->setRequired(TRUE)
      ->setSettings(array(
        'allowed_values' => [
          1 => t('1 photo'),
          2 => t('2

Pour installer un module via le code dans drupal 8 il faut utiliser le service ModuleInstaller, exemple avec le snippet suivant :

Comment récupérer le nombre de fois qu'une entité a été « flaguée » via le module Flag dans drupal 8 :

Via le hook hook_page_attachments() :

Simplement utiliser la méthode "addRole" sur l'utilisateur en question en lui passant le nom machine (l'id) du rôle :

$user->addRole('mon_role')

Si vous voulez le faire à la création de l'utilsateur alors vous pouvez utiliser le HOOK_user_presave :

On commence par récupérer le service de gestion des blocks :

$block_manager = \Drupal::service('plugin.manager.block');

On construit le bloc que l'on souhaite via son id

$fields['description'] = BaseFieldDefinition::create('text_long')
  ->setLabel(t('Description'))
  ->setSetting('text_processing', FALSE)
  ->setDisplayConfigurable('view', TRUE)
  ->setDisplayConfigurable('form', TRUE);

Pour avoir une zo

    $fields['classement'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Classement activé'))
      ->setDescription(t('Doit-on calculer le classement entre les équipes pour cette competitions'))
      //est-ce que l'on autorise les modifications 

Pour charger toute l'arborescence :

$categories = \Drupal::service('entity_type.manager')
  ->getStorage('taxonomy_term')
  ->loadTree('NOM_MACHINE_VOCABULAIRE');

Pour charger que l'arborescence en partant d'un taxon (term) donné :

Ces bouts de codes peuvent être utilisé dans des hook update ou des fonction de post_update.

$fields['subtitle'] = BaseFieldDefinition::create('string')
  ->setLabel(t('Sous-titre'))
  ->setDescription(t('Sous-titre de la diapositive'))
  ->setSetting('max_length', 255) 
  ->setSetting('text_processing', 0) 
  ->setDefaultValue('')
  ->setD

Les alias d'url sont des URI « propres » faisant référence à une URI système. Exemple pour ce contenu, l'alias est /snippets/2016/drupal-8-drupal-9-creer-un-alias-durl-dans-le-code.html et le chemin système est : /node/166.

Ici mon type d'entitée est "group" :

$view = views_get_view_result($view_name,$display_mode,$view_args);
$nb_result = count($view);

Dans views quand l'on veut avoir un champ personnalisé un peu tiré par les cheveux, on peut y aller comme un porc en utilisant le hook_views_pre_render ou alors on peut definir un custom field.

Première étape, implémenter le HOOK_views_data() afin de définir le champ :

Comment utiliser count dans un db_select avec Drupal ?

Dans l'exemple ci-dessous, on détermine le nombre de nodes de type "page" publiées.

Quand l'on fait des jointures on veut parfois récupérer les enregistrements dont un champ n'est pas renseigné ou au contraire que ceux qui le sont.

Pour cela en SQL on utilise le "IS NULL" ou "IS NOT NULL".

Parfois vous pouvez vous retrouver avec un problème d'intégrité de données qui entraîne l'impossibilité de supprimer un champ, voici comment faire avec Drush, dans un terminal donc :

Le script suivant permet de créer un nouveau vocabulaire et de lui affecter des termes en concervant l'ordre défini dans le tableau.

Il est à utiliser dans un HOOK_install ou un HOOK_update_X par exemple.

Pour faire du ménage sur un site et supprimer tous les contenus de test, on peut biensûr le faire à la main, ou utiliser un script.

Celui qui suit fonctionne à la fois pour les types de contenu mais aussi pour les entités custom.

Via la fonction drupal_get_form il est possible de passer des variables à notre formulaire custom.

ECK (Entity Construction Kit) est un module qui permet de créer facilement vos types d'entités via l'interface d'administration de Drupal.

Afficher un block créé via l'administration

$identifiant = 1; //c'est l'identifiant du bloc visible dans l'url lors de sa modification
$block = block_load('block', $identifiant);

$monBlock = _block_get_renderable_array(_block_render_blocks(array($block)));

//Code

Les #states drupal permettent d'ajouter facilement une couche javascript sur nos formulaires, pour par exemple afficher un champ en fonction d'un autre...

Ces exemples marchent sur les version drupal 7, 8, 9 et 10.

Chargement d'une entité :

Dans une fonction :