Skip to main content
Les plugins WordPress peuvent être étendus pour répondre à vos besoins précis à l’aide d’actions et de filtres, afin d’exécuter du code personnalisé à des points précis durant l’exécution. Ce document présente les hooks existants dans le plugin Login by Auth0. Nous serons ravis d’examiner et d’approuver de nouveaux filtres et de nouvelles actions qui vous permettront d’intégrer encore davantage ce plugin. Pour en savoir plus, consultez la section Contributing dans le README du dépôt GitHub du plugin.

​
Actions de WordPress

Les actions de WordPress exécutent du code personnalisé à des étapes précises du traitement. Pour en savoir plus sur les actions de WordPress, consultez WordPress Plugin Handbook: Actions sur wordpress.org.

​
auth0_before_login

Cette action s’exécute dans WP_Auth0_LoginManager après qu’un utilisateur a été authentifié avec succès, mais avant qu’il ne soit connecté à WordPress. Elle peut servir à interrompre le processus de connexion au besoin à l’aide de wp_die() ou en lançant une exception.

​
auth0_user_login

Cette action s’exécute dans WP_Auth0_LoginManager après qu’un utilisateur a été authentifié avec succès et connecté à WordPress. Elle peut servir à définir des métadonnées précises, à envoyer des notifications ou à envoyer une requête ping à d’autres services.

​
wpa0_user_created

Cette action s’exécute dans WP_Auth0_Users juste après la création réussie d’un utilisateur WordPress. Elle peut servir à modifier les données de l’utilisateur, à définir des métadonnées utilisateur supplémentaires ou à déclencher d’autres actions liées aux nouveaux utilisateurs.

​
Filtres

Dans WordPress, les filtres exécutent également du code personnalisé à des étapes précises du processus, mais ils renvoient toujours une valeur modifiée du même type que celle transmise. Pour en savoir plus sur les filtres, consultez WordPress Plugin Handbook: Filters on wordpress.org.

​
auth0_create_user_data

Ce filtre peut être utilisé pour modifier le tableau de données utilisateur lors de la création d’un nouvel utilisateur dans WordPress à partir d’un utilisateur Auth0 reçu. Il reçoit 2 paramètres :
  • $user_data correspond aux données utilisateur extraites du profil Auth0.
  • $userinfo correspond au profil utilisateur Auth0.
Ce filtre doit toujours retourner un tableau de données qui sera transmis à la fonction de base wp_insert_user().

​
auth0_get_wp_user

Ce filtre est appelé une fois que l’extension a trouvé l’utilisateur correspondant pour la connexion (à partir du user_id Auth0) et sert à remplacer le comportement par défaut par des règles de correspondance personnalisées (par exemple, toujours faire la correspondance par courriel). Si le filtre renvoie null, la recherche se fera par courriel. Pour en savoir plus, consultez Intégrer à WordPress.

​
auth0_verify_email_page

Ce filtre est exécuté dans WP_Auth0_Email_Verification pour modifier le HTML affiché lorsqu’un utilisateur qui se connecte doit vérifier son courriel avant d’avoir accès au site. Notez que ce HTML est transmis à wp_die(), où il est modifié avant d’être affiché (consultez la définition de _default_wp_die_handler() dans le noyau pour plus d’informations).

​
auth0_get_auto_login_connection

Ce filtre est utilisé dans WP_Auth0_LoginManager pour modifier la connexion utilisée pour le processus de connexion automatique. Le réglage défini dans wp-admin est récupéré, puis soumis à ce filtre.

​
wp_auth0_get_option

Ce filtre est utilisé par les fonctions et les méthodes de récupération d’options pour modifier la valeur renvoyée.

​
auth0_migration_ws_authenticated

Ce filtre est utilisé dans WP_Auth0_Routes pour modifier l’objet WP_User encodé en JSON et renvoyé à Auth0 dans le cadre d’une migration d’utilisateurs.

​
wpa0_should_create_user

Ce filtre est utilisé dans WP_Auth0_Users pour déterminer si un utilisateur doit être créé. La valeur initiale transmise est TRUE. Si FALSE est renvoyé pour une raison quelconque, l’inscription sera rejetée et l’utilisateur en cours d’inscription verra un message d’erreur (WP_Auth0_UsersRepo::create()).

​
auth0_login_css

Ce filtre sert à modifier le CSS de la page de connexion, y compris celui du widget de connexion lui-même. Ce filtre s’exécute avant que le CSS ne soit récupéré depuis la page Settings de wp-admin.

​
auth0_login_form_tpl

Filtre le modèle utilisé pour le formulaire de connexion Auth0. Cette fonction doit renvoyer le chemin d’accès à un fichier contenant du HTML qui remplace le contenu de wp-content/plugins/auth0/templates/auth0-login-form.php. Le script JS standard d’initialisation de Lock recherche l’attribut ID auth0-login-form pour instancier le formulaire de connexion; assurez-vous donc qu’il est présent, ou remplacez le fichier wp-content/plugins/auth0/assets/js/lock-init.js par le vôtre.

​
auth0_settings_fields

Ce filtre sert à modifier un champ de formulaire existant ou à en ajouter un nouveau. Il doit retourner un tableau $options modifié contenant vos changements ou vos ajouts. Les nouveaux champs doivent avoir une fonction de rappel pour le champ, comme indiqué ci-dessous.

​
auth0_auth_scope

Ce filtre permet aux développeurs d’ajouter ou de modifier le scope demandé lors de la connexion. Il peut servir à ajouter des custom claims ou à demander un . Utilisez ce filtre pour modifier le nom du cookie servant à la validation du . Consultez le filtre auth0_state_cookie_name ci-dessous pour obtenir un exemple. Utilisez ce filtre pour modifier le nom du cookie utilisé pour la valeur du paramètre state. Vous pouvez ainsi ajouter un préfixe ou un suffixe, ou remplacer complètement la chaîne. Pour en savoir plus sur le paramètre state, consultez Prévenir les attaques et rediriger les utilisateurs avec les paramètres state d’OAuth 2.0. Assurez-vous d’utiliser uniquement des caractères valides dans les modifications apportées : A <cookie-name> can be any US-ASCII characters except control characters (CTLs), spaces, or tabs. It also must not contain a separator character like the following: ( ) < > @ , ; : \ " / ? = { }. Pour en savoir plus sur l’en-tête de réponse HTTP Set-Cookie, consultez Set-Cookie dans MDN Web Docs.

​
auth0_settings_constant_prefix

Utilisez ce filtre pour modifier le préfixe de la constante servant à redéfinir les réglages de l’extension. Veuillez noter que ce filtre doit être exécuté avant le chargement de l’extension Auth0 ; il doit donc être placé dans une extension MU. Pour en savoir plus sur les extensions MU, consultez Must Use Plugins on wordpress.org.

​
auth0_authorize_url_params

Ce filtre permet aux développeurs d’ajuster, au besoin, les paramètres du point de terminaison /authorize. La fonction doit retourner un tableau de type dictionnaire de paramètres d’URL. Pour en savoir plus sur l’utilisation de ces paramètres, consultez Authentication API Explorer: Login.

​
auth0_authorize_url

Ce filtre permet aux développeurs de modifier l’URL /authorize au complet avant son utilisation. La fonction doit renvoyer une URL valide sous forme de chaîne de caractères. Pour en savoir plus sur l’utilisation de cette URL, consultez Authentication API Explorer : Login.

​
auth0_die_on_login_output

Ce filtre vous permet de modifier ou de remplacer le contenu HTML envoyé à wp_die() lorsqu’une erreur survient lors de la connexion. Ce filtre n’a aucune incidence sur le contenu de la vérification du courriel (voir auth0_verify_email_page).

​
auth0_coo_auth0js_url

Ce filtre vous permet de remplacer l’URL CDN par défaut d’Auth0.js lors du chargement de la page de solution de secours du COO.

​
auth0_slo_return_to

Ce filtre vous permet de remplacer l’URL returnTo par défaut lors de la déconnexion d’Auth0.

​
auth0_logout_url

Ce filtre vous permet de remplacer l’URL de déconnexion d’Auth0. Pour en savoir plus sur son utilisation, consultez Logout.

​
auth0_use_management_api_for_userinfo

Ce filtre détermine si les données du profil utilisateur récupérées à partir de l’ doivent être utilisées lorsque vous n’utilisez pas le flux de connexion implicite. Retournez la valeur booléenne true (par défaut) pour utiliser l’API, ou false pour utiliser le .

​
auth0_lock_options

Ce filtre peut être utilisé pour modifier les options du formulaire de connexion Lock intégré utilisé dans les shortcodes, les widgets et sur la page wp-login.php lorsque l’option Fonctionnalités > Page est désactivée.

​
auth0_jwt_leeway

Ce filtre vous permet d’ajuster la marge de tolérance utilisée pour valider les jetons d’identité et doit renvoyer un nombre entier de secondes.

​
auth0_jwt_max_age

Ce filtre vous permet d’ajuster le paramètre d’URL max_age envoyé dans l’URL d’autorisation.

​
auth0_authorize_state

Ce filtre vous permet de filtrer les données state avant qu’elles soient encodées et utilisées pour la connexion. Ces données seront vérifiées après une connexion réussie et fournies telles quelles afin que vous puissiez les utiliser.

​
En savoir plus