Le but de ce guide est de répertorier tous les hooks et filtres disponibles dans le plugin et de fournir un guide étape par étape sur la façon d'intégrer des formulaires ou de modifier les fonctionnalités du plugin.
Vérification par e-mail / Vérification SMS / Vérification OTP
GUIDE D'INTÉGRATION DE FORMULAIRE
ÉTAPE 1. DÉFINIR UNE VARIABLE DE SESSION
Définissez une variable de session indiquant que la vérification OTP a commencé pour votre formulaire.
$_SESSION [ '' ] = 'commencé';
ÉTAPE 2. LE FORMULAIRE FAIT-IL DES APPELS AJAX ?
Ajoutez le filtre suivant pour indiquer si votre formulaire actuel soumet le formulaire à l'aide d'un appel AJAX. La fonction doit vérifier si la vérification OTP a été lancée pour un formulaire et si ce formulaire effectue un appel AJAX. Doit renvoyer VRAI ou FAUX.
add_filter ( 'is_ajax_form' , tableau ( $ This , 'is_ajax_form_in_play' ), 1 , 1 ); public fonction is_ajax_form_in_play ( $isAjax ){ // Vérifiez s'il y a une session active. if ( session_id () == '' || ! Isset ( $_SESSION )) session_start (); // Si le formulaire actuel effectue un appel AJAX pour soumettre le formulaire retourner Isset ( $_SESSION [ ' ' ]) ? VRAI : $isAjax; // Si le formulaire actuel effectue un appel AJAX pour soumettre le formulaire retourner Isset ( $_SESSION [ ' ' ]) ? FAUX : $isAjax; }
ÉTAPE 3. AJOUTER UN CODE POUR LANCER LA VÉRIFICATION OTP
// Pour la vérification par téléphone/mobile faire_action ('mo_generate_otp', NULL , NULL , NULL , $numéro_téléphone, "téléphone", NULL , NULL , NULL ); // Pour la vérification des e-mails faire_action ('mo_generate_otp', NULL ,$email, NULL , NULL ,"e-mail", NULL , NULL , NULL );
ÉTAPE 4. AJOUTER UN CODE POUR VALIDER L'OTP (POUR LES FORMULAIRES AJAX)
Ajoutez le code suivant uniquement si vous intégrez un formulaire AJAX pour valider l'OTP saisi par l'utilisateur après la soumission du formulaire.
do_action ( 'mo_validate_otp' , NULL , $otpEnteredByUser );
ÉTAPE 5. AJOUTER UNE ACTION POUR GÉRER UNE VALIDATION RÉUSSIE
Utilisez le crochet d'action suivant pour déterminer ce qui doit être fait une fois que l'utilisateur a validé avec succès l'OTP envoyé à son téléphone ou à son e-mail.
ajouter_action ( 'otp_verification_successful' , tableau ( $ This , 'handle_post_verification' ), 10 , 6 ); fonction handle_post_verification ( $redirection_vers , $utilisateur_login , $utilisateur_email , $mot de passe , $numéro_de_téléphone , $extra_data){ // Vérifiez s'il y a une session active. if ( session_id () == '' || ! Isset ( $_SESSION )) session_start (); // retourne si la vérification OTP n'a pas été démarrée if ( !Isset ( $_SESSION [ ' ' ])) retour; //entrez votre code ci-dessous pour traiter le formulaire soumis . . . }
ÉTAPE 6. AJOUTER UNE ACTION POUR GÉRER L'ÉCHEC DE LA VALIDATION
Utilisez le crochet d'action suivant pour déterminer ce qui doit être fait après que l'utilisateur n'a pas réussi à valider l'OTP envoyé à son téléphone ou à son e-mail. Soit l'utilisateur a saisi un OTP non valide, soit une autre erreur s'est produite.
ajouter_action ( 'otp_verification_failed' , tableau ( $ This , 'handle_failed_verification' ), 10 , 3 ); fonction handle_failed_verification ( $utilisateur_login , $utilisateur_email , $numéro_de_téléphone ){ // Vérifiez s'il y a une session active. if ( session_id () == '' || ! Isset ( $_SESSION )) session_start (); // retourne si la vérification OTP n'a pas été démarrée if (! Isset ( $_SESSION [ ' ' ])) retour; // cette action est appelée pour supprimer la variable de session do_action ( 'unset_session_variable' ); // entrez votre code ci-dessous pour traiter l'échec de la validation . . . }
ÉTAPE 7. AJOUTER UNE ACTION AUX VARIABLES DE SESSION NON DÉFINIES
Utilisez le crochet d'action suivant pour supprimer les variables de session que vous aviez définies précédemment. Ceci est important car cela est appelé à partir de divers endroits par le plugin pour désactiver les variables de session.
ajouter_action ( 'unset_session_variable' , tableau ( $ This , 'unsetSessionVariables' ), 1 , 0 ); public fonction unsetSessionVariables (){ unset ( $_SESSION [' mo_customer_validation_site_txID ']); unset ( $_SESSION [ ' ' ]); }
CROCHETS ET FILTRES PLUGIN
ACTIONS
>> otp_verification_successful
/ ** * Ce hook est déclenché une fois que l'OTP saisi par l'utilisateur a été validé avec succès. * Utilisez ce hook pour modifier/décider de la fonctionnalité une fois que l'utilisateur a entré le * OTP correct et le système l'a validé avec succès. * @pour moi $redirect_to la redirection vers l'URL après l'enregistrement d'un nouvel utilisateur * @pour moi $user_login le nom d'utilisateur publié par l'utilisateur * @pour moi $user_email l'email posté par l'utilisateur * @pour moi $password le mot de passe posté par l'utilisateur * @pour moi $phone_number le numéro de téléphone posté par l'utilisateur * @pour moi $extra_data toute donnée supplémentaire publiée par l'utilisateur */ ajouter_action( 'otp_verification_successful', fonction ($redirect_to,$user_login,$user_email,$password,$phone_number,$extra_data){ // ton code va ici },10,6 );
>> otp_verification_failed
/** * Ce hook est déclenché une fois que l'OTP saisi par l'utilisateur a été validé avec succès. * Utilisez ce hook pour modifier/décider de la fonctionnalité une fois que l'utilisateur a saisi le * mauvais OTP et que le système l'a validé avec succès. * @pour moi $user_login le nom d'utilisateur posté par l'utilisateur * @pour moi $user_email l'email posté par l'utilisateur * @pour moi $phone_number le numéro de téléphone posté par l'utilisateur */ add_action( 'otp_verification_failed', fonction handle_failed_verification ($ user_login, $ user_email, $ phone_number){ //votre code va ici },10,3 );
>> unset_session_variable
/ ** * Ce hook est déclenché pour supprimer toutes les variables de session afin qu'une * nouvelle soumission de formulaire démarre un nouveau processus de vérification OTP. * Utilisez ce hook pour modifier ou ajouter votre propre code afin d'effacer l'activité de l'utilisateur * à partir de la session. */ ajouter_action( 'unset_session_variable', une fonction(){ // votre code va ici } );
>> mo_registration_show_message
/ ** * Le hook est déclenché pour afficher un plugin généré message à l'utilisateur dans * le tableau de bord d'administration. Utilisez ce hook pour modifier les messages affichés * à l'utilisateur dans le tableau de bord d'administration. * @pour moi $content fait référence au contenu du message * @pour moi $type fait référence au type de message */ ajouter_action( 'mo_registration_show_message', fonction($content,$type) { // votre code ici },10,2 );
>> mo_generate_otp
/ ** * Ce hook est déclenché pour démarrer l'OTP Processus de vérification. * Utilisez ce hook pour modifier le processus d'envoi d'OTP au téléphone ou à l'adresse e-mail d'un * utilisateur. Vous pouvez même appeler ce hook pour * lancer une demande OTP sur le téléphone ou l'e-mail d'un utilisateur. * @pour moi chaîne $user_login nom d'utilisateur soumis par l'utilisateur * @pour moi string $user_email email soumis par l'utilisateur * @pour moi chaîne $errors variable d'erreur (actuellement non utilisée) * @pour moi string $phone_number numéro de téléphone soumis par l'utilisateur * @pour moi string $otp_type vérification par e-mail ou sms * @pour moi string $password mot de passe soumis par l'utilisateur * @pour moi string $extra_data un tableau contenant toutes les données supplémentaires soumises par l'utilisateur * @pour moi bool $from_both indique si l'utilisateur a le choix entre la vérification par e-mail et par téléphone */ add_action( 'mo_generate_otp', fonction($user_login, $user_email, $errors, $phone_number = "", $otp_type="email",$password = '', $extra_data = null, $from_both = false){ // votre code va ici }, 1,8 );
>> mo_validate_otp
/ ** * Ce hook est déclenché pour démarrer le processus de validation de vérification OTP. * Utilisez ce hook pour modifier le processus de validant le jeton OTP soumis * par l'utilisateur. Vous pouvez même lancer cette action pour valider un OTP* soumis par l'utilisateur. * @pour moi string $requestVariable la clé du jeton otp dans le paramètre post * @pour moi chaîne $otp_token jeton otp soumis */ ajouter_action( 'mo_validate_otp', fonction($requestVariable,$otp_token){ // ton code va ici },1,8 );
>> mo_otp_verification_add_on_controller
/** * Ce hook est déclenché pour afficher les paramètres du module complémentaire. Si vous souhaitez créer un * module complémentaire personnalisé, utilisez ce hook pour contrôler les données et la vue affichées par * votre module complémentaire. */ add_action(
'mo_otp_verification_add_on_controller',
fonction(){ // votre code va ici } );
>> mo_otp_verification_delete_addon_options
/** * Ce hook est déclenché pour supprimer les paramètres du module complémentaire. Si vous souhaitez créer un * module complémentaire personnalisé, utilisez ce hook pour déclencher la * suppression des paramètres de votre module complémentaire lorsque le plugin est supprimé. */ add_action(
'mo_otp_verification_delete_addon_options',
fonction(){ // votre code va ici } );
FILTRES
>> get_mo_option
/ **
* Ce filtre est appliqué sur chaque valeur provenant de la base de données. * Accrochez-vous à ce filtre pour modifier les valeurs provenant de la base de données.
* @pour moi $key le nom_option pour récupérer la valeur de la base de données * @pour moi $prefix la valeur de chaîne à préfixer au nom_option avant de récupérer les données
* @revenir Chaîne
*/
ajouter_filter(
'get_mo_option',
fonction($clé,$préfixe) {
// votre code va ici // renvoie une valeur de la base de données
},10,2
);
>> update_mo_option
/ ** * Ce filtre est appliqué sur chaque valeur avant qu'elle ne soit mise dans la base de données. * Accrochez-vous à ce filtre pour modifier les valeurs avant qu'elles ne soient enregistrées dans la base de données * WordPress. * @pour moi $key le nom_option pour récupérer la valeur de la base de données * @pour moi $value la valeur à sauvegarder dans la base de données * @pour moi $prefix la valeur de chaîne à préfixer au nom_option avant de récupérer les données * @revenir Chaîne */ ajouter_filter( 'update_mo_option', fonction($clé,$valeur,$préfixe) { // ton code va ici // renvoie une valeur de la base de données },10,3 );
>> mo_phone_dropdown_selector
/** * Un filtre pour modifier le tableau de sélecteurs jQuery afin d'afficher * la liste déroulante du champ de téléphone. Connectez-vous à ce filtre pour modifier ou * le champ de téléphone de votre propre formulaire comme sélecteur pour afficher * la liste déroulante du pays. * @pour moi array $selector tableau de sélecteurs jQuery * @revenir tableau */ add_filter(
'mo_phone_dropdown_selector',
fonction($selector){ // votre code va ici // return $selector },10,1
);
>> mo_template_defaults
/** * Ce filtre est déclenché avant que chaque modèle pop-up par défaut ne soit enregistré dans le * plugin. Connectez-vous à ce filtre pour modifier le modèle contextuel par défaut avant * qu'il ne soit enregistré dans la base de données. * @pour moi array $templates un tableau de paires clé-valeur composé de tous les modèles HTML pour les pop-ups * @revenir tableau */ add_filter(
'mo_template_defaults',
fonction($templates) { // votre code va ici // return $templates } );
>> mo_template_build
/** * Ce filtre est déclenché pour créer chaque modèle pop-up et remplacer les balises * par du code HTML avant de l'afficher à l'écran aux utilisateurs. * Connectez-vous à ce filtre pour modifier ou ajouter votre propre contenu aux fenêtres contextuelles. * Renvoie le contenu HTML de la fenêtre contextuelle particulière. * @pour moi $template le contenu du modèle à modifier * @pour moi $templateType le type de modèle * @pour moi $message le message à afficher dans la popup * @pour moi $otp_type le type otp invoqué * @pour moi $from_both l'utilisateur a-t-il la possibilité de choisir la vérification n/b par e-mail et SMS * @revenir Chaîne */ add_filter( 'mo_template_build', fonction($template,$templateType,$message,$otp_type,$from_both){ // votre code va ici // renvoie le contenu HTML },1,5 );
>> mo_blocked_email_domains
/ ** * Connectez-vous à ce filtre pour modifier la liste des domaines de messagerie bloqués. * Ce filtre est appelé avant une tentative d'envoi d'un OTP à l'adresse email * de l'utilisateur pour vérifier si l'email saisi a été blacklisté * par l'administrateur du site. * @param array $blocked_email_domains une liste des domaines de messagerie bloqués * @return tableau */ ajouter_filter( 'mo_blocked_email_domains', fonction($blocked_email_domains) { // ton code va ici // renvoie $blocked_email_domains },10,1 );
>> mo_blocked_phones
/ ** * Connectez-vous à ce filtre pour modifier la liste des numéros de téléphone bloqués. * Ce filtre est appelé avant une tentative d'envoi d'un OTP au compte de l'utilisateur. * téléphone pour vérifier si le numéro de téléphone a été mis sur liste noire *par l'administrateur du site. Assurez-vous que le numéro de téléphone est au format * international, par exemple : +1xxxxxxxxx * @pour moi tableau $blocked_phones une liste de domaines de messagerie bloqués * @revenir tableau */ ajouter_filter( 'mo_blocked_phones', fonction($blocked_phones) { // ton code va ici // renvoie $blocked_phones },10,1 );
>> mo_filter_phone_before_api_call
/** * Ce filtre est appelé avant que le numéro de téléphone ne soit transmis à l'API * Gateway pour envoyer un message OTP à l'utilisateur. Connectez-vous à ce * filtre pour apporter des modifications au numéro de téléphone avant qu'il * ne soit envoyé à la passerelle SMS pour la livraison OTP. * @pour moi String $phone le numéro de téléphone à traiter * @revenir Chaîne * * @note Ce filtre est uniquement disponible pour le plan Votre passerelle */ add_filter(
'mo_filter_phone_before_api_call',
fonction($phone_number){ // votre code va ici // renvoie $phone_number },10,1
);
>> personnaliser_otp_url_before_api_call
/** * Ce filtre est appelé avant que l'appel API ne soit effectué pour envoyer un message OTP * à l'utilisateur. Connectez-vous à ce filtre pour apporter des modifications à l'URL * avant qu'elle ne soit utilisée pour effectuer l'appel API. * @pour moi String $url l'URL de la passerelle SMS * @pour moi String $message le message OTP à envoyer au téléphone de l'utilisateur * @pour moi String $phone le numéro de téléphone à traiter * @revenir String * * @note Ce filtre est uniquement disponible pour le plan Votre passerelle */ add_filter(
'customize_otp_url_before_api_call',
fonction($url,$message,$phone){ // votre code va ici // return $url },10,3
);
>> mo_process_phone
/** * Ce filtre est appelé pour traiter le numéro de téléphone immédiatement après la soumission du formulaire *. Accrochez-vous à ce filtre si vous souhaitez modifier le numéro de téléphone* avant qu'il ne soit traité par le formulaire et le plugin. * @pour moi String $phone le numéro de téléphone à traiter * @revenir Chaîne */ add_filter(
'mo_process_phone',
fonction($phone){ // votre code va ici // renvoie $phone },10,1
);
>> is_ajax_form
/** * Ce filtre est appelé pour vérifier si le formulaire actuel pour lequel l'utilisateur * lance la vérification OTP effectue un appel AJAX pour soumission * ou non. Connectez-vous à ce filtre pour ajouter les données de votre propre formulaire ou modifier * les données du formulaire existant pendant le processus de vérification OTP. * @pour moi bool $isAjax Valeur vraie ou fausse * @revenir bool */ add_filter(
'is_ajax_form',
fonction($isAjax){ // votre code va ici // renvoie $isAjax },10,1
);
>> is_login_or_social_form
/** * Ce filtre est appelé pour vérifier si le formulaire actuel pour lequel l'utilisateur * lance la vérification OTP est un formulaire de connexion ou de connexion sociale * ou non. Connectez-vous à ce filtre pour ajouter les données de votre propre formulaire ou modifier * les données du formulaire existant pendant le processus de vérification OTP. * @pour moi bool $isLoginOrSocialForm Valeur vraie ou fausse * @revenir bool */ add_filter(
'is_login_or_social_form',
fonction($isLoginOrSocialForm){ // votre code va ici // return $isAjax },10,1
);
>> mo_curl_page_url
/** * Ce filtre est appelé pour modifier l'URL de la page actuelle. Ce filtre * est appelé pendant le processus de vérification OTP pour garder une trace de la page * pour laquelle l'utilisateur a lancé la vérification OTP. L'utilisateur est redirigé vers cette * page lorsqu'il clique sur le bouton Revenir en arrière sur la page contextuelle OTP. * Accrochez-vous à ce filtre pour modifier l'URL de la page actuelle. * @pour moi String $pageURL l'URL de la page actuelle * @revenir Chaîne */ add_filter(
'mo_curl_page_url',
fonction($pageURL){ // votre code va ici // renvoie $pageURL },10,1
);
