Syftet med den här guiden är att lista alla krokar och filter som är tillgängliga i plugin-programmet och ge en steg-för-steg-guide om hur man integrerar formulär eller ändrar funktionaliteten i plugin-programmet.
FORMULÄR INTEGRATIONSGUIDE
STEG 1. STÄLL IN EN SESSIONSVARIABEL
Ställ in en sessionsvariabel som indikerar att OTP-verifieringen har startat för ditt formulär.
$ _SESSIONâ € <[â € <''â € <]â € < â € <=â € < â € <'satte igång';
STEG 2. SAMTALAR FORMEL AJAX?
Lägg till följande filter för att ange om ditt nuvarande formulär skickar formuläret med ett AJAX-anrop. Funktionen bör kontrollera om otp-verifiering har startats för ett formulär och om det formuläret gör ett AJAX-anrop. Bör returnera TRUE eller FALSE.
add_filterâ € <(â € < â € <'är_ajax_form'â € <,â € < arrayâ € <(â € <$ dettaâ € <,â € <'är_ajax_form_i_spel'â € <),â € < â € <1â € <,â € <1â € <); allmänâ € < â € <fungeraâ € < är_ajax_form_in_playâ € <(â € <$isAjaxâ € <){ // Kontrollera om det finns en aktiv session. ifâ € < â € <(â € <session_idâ € <()â € < â € <==â € < â € <''â € < â € <||â € < â € <!â € <issetâ € <(â € <$ _SESSIONâ € <))â € < session_startâ € <(); // Om det aktuella formuläret gör ett AJAX-anrop för att skicka formuläret avkastningâ € < â € <issetâ € <(â € <$ _SESSIONâ € <[â € <' 'â € <])â € < â € <?â € < SANN â € <:â € < $isAjax; //â € <Om det aktuella formuläret gör ett AJAX-anrop för att skicka formuläret avkastningâ € < â € <issetâ € <(â € <$ _SESSIONâ € <[â € <' 'â € <])â € < â € <?â € < FALSK â € <:â € < $isAjax; }
STEG 3. LÄGG TILL KOD FÖR ATT INITIERA OTP-VERIFIERING
// För telefon-/mobilverifiering do_action('mo_generate_otp',â € <NULLâ € <,â € <NULLâ € <,â € <NULLâ € <, $phone_number,"phone", â € <NULLâ € <,â € <NULLâ € <,â € <NULLâ € <); // För e-postverifiering do_action('mo_generate_otp',â € <NULLâ € <,$email,â € <NULLâ € <, â € <NULLâ € <,"e-post", â € <NULLâ € <,â € <NULLâ € <,â € <NULLâ € <);
STEG 4. LÄGG TILL KOD FÖR ATT VALIDERA OTP (FÖR AJAX FORMULAR)
Lägg till följande kod endast om du integrerar med ett AJAX-formulär för att validera OTP som angetts av användaren efter att formuläret skickats in.
do_actionâ € <(â € <'mo_validate_otp'â € <,â € <NULLâ € <,â € <$otpEnteredByUserâ € <);
STEG 5. LÄGG TILL ÅTGÄRD FÖR ATT HANTERA LYCKAD VALIDERING
Använd följande åtgärdskrok för att avgöra vad som behöver göras efter att användaren framgångsrikt har validerat den OTP som skickats till hans telefon eller e-post.
add_actionâ € <(â € < â € <'otp_verification_successful'â € <,â € <arrayâ € <(â € <$ dettaâ € <,â € <"handle_post_verification"â € <),â € <10â € <,â € <6â € <); fungeraâ € < handle_post_verificationâ € <(â € <$redirect_toâ € <,â € <$user_loginâ € <,â € <$user_emailâ € <, $lösenordâ € <, â € <$phone_numberâ € <,â € <$extra_data){ // Kontrollera om det finns en aktiv session. ifâ € < â € <(â € <session_idâ € <()â € < â € <==â € < â € <''â € < â € <||â € < â € <!â € <issetâ € <(â € <$ _SESSIONâ € <))â € < session_startâ € <(); // returnera om otp-verifiering inte startades ifâ € <(â € <!issetâ € <(â € <$ _SESSIONâ € <[â € <' 'â € <]))â € < â € <tillbaka; //ange din kod nedan för att bearbeta det inskickade formuläret . . . }
STEG 6. LÄGG TILL ÅTGÄRD FÖR ATT HANTERA MISLYCKAD VALIDERING
Använd följande åtgärdskrok för att avgöra vad som behöver göras efter att användaren misslyckats med att validera OTP som skickats till hans telefon eller e-post. Antingen har användaren angett en ogiltig OTP eller så uppstod något annat fel.
add_actionâ € <(â € < â € <'otp_verification_failed'â € <,â € <arrayâ € <(â € <$ dettaâ € <,â € <"handle_failed_verification"â € <),â € <10â € <,â € <3â € <); fungeraâ € < handle_failed_verificationâ € <(â € <$user_loginâ € <,â € <$user_emailâ € <,â € <$phone_numberâ € <){ // Kontrollera om det finns en aktiv session. ifâ € < â € <(â € <session_idâ € <()â € < â € <==â € < â € <''â € < â € <||â € < â € <!â € <issetâ € <(â € <$ _SESSIONâ € <))â € < session_startâ € <(); // returnera om otp-verifiering inte startades ifâ € <(!â € <issetâ € <(â € <$ _SESSIONâ € <[â € <' 'â € <]))â € < â € <tillbaka; â € <// denna åtgärd anropas för att avaktivera sessionsvariabeln do_actionâ € <(â € <'unset_session_variable'â € <);â € < // ange din kod nedan för att bearbeta den misslyckade valideringen . . . }
STEG 7. LÄGG TILL ÅTGÄRD FÖR ATT AVSTÄLLA SESSIONSVARIABLER
Använd följande åtgärdskrok för att avaktivera sessionsvariablerna du hade ställt in tidigare. Detta är viktigt eftersom detta anropas från en mängd olika ställen av pluginet för att avaktivera sessionsvariabler.
add_actionâ € <(â € < â € <'unset_session_variable'â € <,â € < arrayâ € <(â € < $ dettaâ € <,â € < â € <'unsetSessionVariables'â € <),â € < â € <1â € <,â € < â € <0â € <); allmänâ € < â € <fungeraâ € < unsetSessionVariablesâ € <(){ oskränktâ € <(â € <$ _SESSIONâ € <['â € <mo_customer_validation_site_txIDâ € <']); oskränktâ € <(â € <$ _SESSIONâ € <[â € <' 'â € <]); }
PLUGIN-HAKAR OCH FILTER
ÅTGÄRDER
>> otp_verification_successful
/ ** * Denna hook utlöses efter att OTP som angetts av användaren har validerats framgångsrikt. * Använd denna krok för att ändra/bestämma funktionaliteten efter att användaren har gått in i * korrekt OTP och systemet har validerat det framgångsrikt. * @param $redirect_to omdirigeringen till URL efter ny användarregistrering * @param $user_login användarnamnet som lagts upp av användaren * @param $user_email e-postmeddelandet från användaren * @param $password lösenordet som lagts upp av användaren * @param $phone_number telefonnumret som lagts upp av användaren * @param $extra_data all extra data som lagts upp av användaren */ add_action( 'otp_verification_successful', fungera ($redirect_to,$user_login,$user_email,$password,$phone_number,$extra_data){ // din kod kommer hit },10,6 );
>> otp_verification_failed
/** * Denna hook utlöses efter att OTP som användaren angett har validerats. * Använd denna krok för att ändra/bestämma funktionaliteten efter att användaren har angett * fel OTP och systemet har validerat det framgångsrikt. * @param $user_login användarnamnet postat av användaren * @param $user_email e-postmeddelandet från användaren * @param $phone_number telefonnumret som lagts upp av användaren */ add_action( 'otp_verification_failed', fungera handle_failed_verification($user_login,$user_email,$phone_number){ //din kod går hit },10,3 );
>> unset_session_variable
/ ** * Denna hook triggas för att avaktivera alla sessionsvariabler så att en ny formulärinlämning startar en ny process för OTP-verifiering. * Använd denna krok för att ändra eller lägga till din egen kod för tydlig användaraktivitet * från sessionen. */ add_action( 'unset_session_variable', fungera(){// din kod går hit } );
>> mo_registration_show_message
/ ** * Kroken utlöses för att visa en genererad plugin meddelande till användaren i * admin dashboard. Använd den här kroken för att ändra meddelandena som visas * för användaren i administratörspanelen. * @param $content hänvisar till meddelandeinnehållet * @param $type hänvisar till typen av meddelande */ add_action( 'mo_registration_show_message', fungera($content,$type) { // din kod här },10,2 );
>> mo_generate_otp
/ ** * Denna hook triggas för att starta OTP Verifieringsprocess. * Använd denna krok för att ändra processen för att skicka OTP till en * användares telefon eller e-postadress. Du kan till och med ringa denna hook för att * initiera en OTP-begäran till en användares telefon eller egen e-post. * @param sträng $user_login användarnamn skickat av användaren * @param string $user_email e-post som skickats av användaren * @param string $errors felvariabel (används inte för närvarande) * @param string $phone_number telefonnummer som skickats av användaren * @param sträng $otp_type e-post eller sms verifiering * @param sträng $password lösenord som skickats av användaren * @param sträng $extra_data en array som innehåller all extra data som skickats av användaren * @param bool $from_both anger om användaren har ett val mellan e-post och telefonverifiering */ add_action( 'mo_generate_otp', fungera($user_login, $user_email, $errors, $phone_number = "", $otp_type="email",$password = '', $extra_data = null, $from_both = false){// din kod går hit }, 1,8 );
>> mo_validate_otp
/ ** * Denna hook utlöses för att starta OTP-verifieringsprocessen. * Använd denna krok för att ändra processen för validerar OTP-token som skickats * av användaren. Du kan till och med initiera den här åtgärden för att validera en OTP * som skickats av användaren. * @param sträng $requestVariable otp-tokennyckeln i postparametern * @param sträng $otp_token otp-token har skickats */ add_action( 'mo_validate_otp', fungera($requestVariable,$otp_token){ // din kod kommer hit },1,8 );
>> mo_otp_verification_add_on_controller
/** * Denna hook utlöses för att visa tilläggsinställningar. Om du vill bygga ett * anpassat tillägg, använd den här kroken för att kontrollera data och vy som visas av * ditt tillägg. */ add_action(
'mo_otp_verification_add_on_controller',
fungera(){// din kod går hit } );
>> mo_otp_verification_delete_addon_options
/** * Denna hook utlöses för att radera tilläggsinställningar. Om du vill bygga ett * anpassat tillägg, använd den här kroken för att trigga att dina tilläggsinställningar tas bort när pluginet tas bort. */ add_action(
'mo_otp_verification_delete_addon_options',
fungera(){// din kod går hit } );
FILTER
>> get_mo_option
/ **
* Detta filter tillämpas på varje värde som kommer från databasen. * Haka i detta filter för att ändra värdena som kommer från databasen.
* @param $key the option_name för att hämta värdet från databasen * @param $prefix strängvärdet som ska prefixas till option_name innan data hämtas
* @lämna tillbaka Sträng
*/
add_filter(
'get_mo_option',
fungera($nyckel,$prefix) {
// din kod går hit // returnerar ett värde från databasen
},10,2
);
>> update_mo_option
/ ** * Detta filter tillämpas på varje värde innan det sätts i databasen. * Haka i detta filter för att ändra värdena innan de sparas i * WordPress-databasen. * @param $key the option_name för att hämta värdet från databasen * @param $value värdet som ska sparas i databasen * @param $prefix strängvärdet som ska prefixas till option_name innan data hämtas * @lämna tillbaka Sträng */ add_filter( 'update_mo_option', fungera($nyckel,$värde,$prefix) { // din kod kommer hit // returnera ett värde från databasen },10,3 );
>> mo_phone_dropdown_selector
/** * Ett filter för att modifiera arrayen av jQuery-väljare för att visa * telefonfältets rullgardinsmeny på. Koppla in det här filtret för att ändra eller * ditt eget formulärs telefonfält som en väljare för att visa land * rullgardinsmenyn. * @param array $selector array av jQuery-väljare * @lämna tillbaka array */ add_filter(
'mo_phone_dropdown_selector',
fungera($selector){// din kod kommer hit // return $selector },10,1
);
>> mo_template_defaults
/** * Det här filtret utlöses innan varje standard popup-mall sparas i insticksprogrammet *. Haka i det här filtret för att ändra standard popup-mallen innan * de sparas i databasen. * @param array $templates en nyckelvärdespararray som består av alla HTML-mallar för popup-fönster * @lämna tillbaka array */ add_filter(
'mo_template_defaults',
fungera($templates) { // din kod går hit // return $templates } );
>> mo_template_build
/** * Det här filtret utlöses för att bygga varje popup-mall och ersätta *-taggarna med HTML-kod innan det visas på skärmen för användarna. * Anslut till detta filter för att ändra eller lägga till ditt eget innehåll i popup-fönster. * Returnera HTML-innehållet för det specifika popup-fönstret. * @param $template mallens innehåll som ska ändras * @param $templateTyp malltypen * @param $message meddelandet som ska visas i popup-fönstret * @param $otp_type den anropade otp-typen * @param $from_both har användaren möjlighet att välja svartvit e-post och sms-verifiering * @lämna tillbaka String */ add_filter( 'mo_template_build', fungera($template,$templateType,$meddelande,$otp_type,$from_both){// din kod går hit // returnera HTML-innehåll },1,5 );
>> mo_blocked_email_domains
/ ** * Haka i det här filtret för att ändra listan över blockerade e-postdomäner. * Det här filtret anropas innan ett försök att skicka en OTP till användarens * e-postadress för att kontrollera om den angivna e-posten har svartlistats * av administratören för webbplatsen. * @param array $blocked_email_domains en lista över blockerade e-postdomäner * @retur array */ add_filter( 'mo_blocked_email_domains', fungera($blocked_email_domains) { // din kod kommer hit // returnera $blocked_email_domains },10,1 );
>> mo_blocked_phones
/ ** * Koppla in det här filtret för att ändra listan med blockerade telefonnummer. * Detta filter anropas innan ett försök att skicka en OTP till användarens * telefon för att kontrollera om telefonnumret har svartlistats * av sajtens administratör. Se till att telefonnumret är i * internationellt format, t.ex.: +1xxxxxxxxxx * @param array $blocked_phones en lista över blockerade e-postdomäner * @lämna tillbaka array */ add_filter( 'mo_blocked_phones', fungera($blocked_phones) { // din kod kommer hit // returnera $blocked_phones },10,1 );
>> mo_filter_phone_before_api_call
/** * Detta filter anropas innan telefonnumret skickas till * Gateway API för att skicka ett OTP-meddelande till användaren. Koppla in det här * filtret för att göra eventuella ändringar av telefonnumret innan det * skickas till SMS Gateway för OTP-leverans. * @param String $phone telefonnumret som ska behandlas * @lämna tillbaka Sträng ** @notera Det här filtret är endast tillgängligt för din gatewayplan */ add_filter(
'mo_filter_phone_before_api_call',
fungera($phone_number){ // din kod kommer hit // return $phone_number },10,1
);
>> customize_otp_url_before_api_call
/** * Detta filter anropas innan API-anropet görs för att skicka ett OTP-meddelande * till användaren. Koppla in det här filtret för att göra ändringar i URL-adressen * innan den används för att göra API-anropet. * @param Sträng $url SMS Gateway URL * @param Sträng $meddelande OTP-meddelandet som ska skickas till användarens telefon * @param String $phone telefonnumret som ska behandlas * @lämna tillbaka String * * @note Detta filter är endast tillgängligt för Your Gateway Plan */ add_filter(
'customize_otp_url_before_api_call',
fungera($url,$message,$phone){ // din kod kommer hit // return $url },10,3
);
>> mo_process_phone
/** * Det här filtret anropas för att behandla telefonnumret omedelbart efter att formuläret * skickats in. Haka i det här filtret om du vill ändra telefonnumret * innan det behandlas av formuläret och plugin-programmet. * @param String $phone telefonnumret som ska behandlas * @lämna tillbaka String */ add_filter(
'mo_process_phone',
fungera($phone){ // din kod kommer hit // return $phone },10,1
);
>> är_ajax_form
/** * Det här filtret anropas för att kontrollera om det aktuella formuläret som användaren * initierar OTP-verifiering för gör ett AJAX-anrop för inlämning * eller inte. Koppla in det här filtret för att lägga till ditt eget formulärs data eller ändra * befintliga formulärdata under OTP-verifieringsprocessen. * @param bool $isAjax True or False värde * @lämna tillbaka bool */ add_filter(
'är_ajax_form',
fungera($isAjax){ // din kod kommer hit // return $isAjax },10,1
);
>> är_login_eller_social_form
/** * Detta filter anropas för att kontrollera om det aktuella formuläret som användaren * initierar OTP-verifiering för är ett inloggnings- eller socialt inloggningsformulär * eller inte. Koppla in det här filtret för att lägga till ditt eget formulärs data eller ändra * befintliga formulärdata under OTP-verifieringsprocessen. * @param bool $isLoginOrSocialForm True or False värde * @lämna tillbaka bool */ add_filter(
'är_inloggning_eller_social_form',
fungera($isLoginOrSocialForm){ // din kod kommer hit // return $isAjax },10,1
);
>> mo_curl_page_url
/** * Det här filtret anropas för att ändra den aktuella sidans URL. Detta filter * anropas under OTP-verifieringsprocessen för att hålla reda på sidan * där användaren initierade OTP-verifiering för. Användaren omdirigeras tillbaka till denna * sida när han klickar på knappen Gå tillbaka på OTP-popup-sidan. * Haka i det här filtret för att ändra webbadressen till den aktuella sidan. * @param Sträng $pageURL den aktuella sidans URL * @lämna tillbaka String */ add_filter(
'mo_curl_page_url',
fungera($pageURL){ // din kod går hit // return $pageURL },10,1
);
