Skip to main content

Configuration

La mise en œuvre réussie du module "Génération du guide de recherche" repose sur une configuration correcte. Ce guide vous accompagnera à travers les étapes nécessaires, depuis les prérequis jusqu'à la configuration spécifique de votre site WordPress pour activer et utiliser le module.

Prérequis​

Avant de procéder à l'activation et à la configuration du module, assurez-vous que votre environnement répond aux exigences suivantes :

  • WordPress : Version 6.4 ou supérieure.
  • PHP : Version 8.2 ou supérieure.
  • Advanced Custom Fields (ACF) Pro : Version 6.0 ou supérieure.
  • Timber : Assurez-vous que le plugin Timber est bien chargé.

Activation du Module​

Le module "guide de recherche" est intégré via un template PHP spécifique qui est appliqué à une page WordPress dédiée.

La clé pour que le module fonctionne correctement est de configurer une page d'options ACF où vous pouvez sélectionner la page cible pour générer le guide de recherche.

L'activation de ce module se fait en deux étapes principales : la sélection de la page et la gestion des droits d'accès.

Sélection de la Page via ACF :​

  1. Tout d'abord assurez vous qu'une page (privée) dédiée à ce module d'import existe, créez en une le cas échéant.
  2. Rendez-vous dans la section des pages d'options du tableau de bord WordPress :
    Ici : Options Globales traduisibles corresponds aux options globales du site. Celles-ci sont pour la plupart traduisibles afin d'afficher un comportement différent suivant la langue utilisée par le visiteur.
    Puis, sous-onglet Pages : régler le champ "Générateur guide de recherche" sur votre page choisie en étape 1.
    Choix de la page du générateur de guide de recherche

Gestion des Droits d'Accès​

Le module est destiné à être utilisé par les contributeurs, principalement dans un environnement de pré-production.

Pour cela, la page créée à l'étape 1 doit impérativement être avec des droit de lecture associé, ici en privé.

warning

L'accès privé restreind la page aux utilisateurs connectés. Donc pour les différents roles (contributeur, éditeur, administrateurs). Si vous souhaitez appliquer plus de restriction vous pourrez modifier le fichier php (voir section suivante).

En suivant ces étapes, vous aurez correctement configuré le module "Guide de recherche" pour qu'il fonctionne sur votre site WordPress. Cette configuration garantit que le module est activé uniquement sous des conditions spécifiques, sécurisant ainsi votre processus d'exportation du guide de recherche.

note

Il serait recommandé d'ajouter une sécurité en s'assurant de limiter l'accès au module pour éviter son utilisation accidentelle en production, ce qui pourrait affecter les données en ligne.

Logique PHP pour l'Activation du Module​

Pour que le module soit activé uniquement sur la page sélectionnée et pour des utilisateurs avec un rôle spécifique, le code suivant est utilisé dans le fichier page.php du thème :

/page.php
// Check Page GUIDE DE RECHERCHE (if settled into options page)
    else if( isset($context['global_pages']['pageGuideRecherche']->ID) && $context['global_pages']['pageGuideRecherche']->ID == get_the_ID() ){
        Timber::render('templates/page-guide-recherche.twig', $context);
    }

Ce fragment de code vérifie si l'ID de la page actuelle correspond à celle sélectionnée pour la génération du guide de recherche dans les options ACF. Si c'est le cas, le template page-guide-recherche.twig est rendu, activant ainsi le module d'exportation pour cette page.

Vous pouvez ici imbriquer d'autres conditions si nécessaire, sur le role de l'utilisateur ou le type d'environnement courant par exemple.