Guía para desarrolladores del complemento de verificación OTP de WordPress

PASO 1. ESTABLECER UNA VARIABLE DE SESIÓN

Establezca una variable de sesión que indique que la verificación OTP ha comenzado para su formulario.

$ _SESIÓN [ '' ]   =   'comenzó';

PASO 2. ¿EL FORMULARIO HACE LLAMADAS AJAX?

Agregue el siguiente filtro para indicar si su formulario actual envía el formulario mediante una llamada AJAX. La función debe verificar si se ha iniciado la verificación otp para un formulario y si ese formulario realiza una llamada AJAX. Debería devolver VERDADERO o FALSO.

add_filter (   'is_ajax_form' ,  matriz ( $ This , 'is_ajax_form_in_play' ),   1 , 1 );

público   función  is_ajax_form_in_play ( $esAjax ){

     // Comprueba si hay una sesión activa.

     if   ( session_id ()   ==   ''   ||   ! Está establecido ( $ _SESIÓN ))  sesión_inicio ();

     // Si el formulario actual realiza una llamada AJAX para enviar el formulario

     volvemos   Está establecido ( $ _SESIÓN [ ' ' ])   ?  VERDADERO  :  $esAjax; 

     // Si el formulario actual realiza una llamada AJAX para enviar el formulario

     volvemos   Está establecido ( $ _SESIÓN [ ' ' ])   ?  FALSO  :  $esAjax;

}

PASO 3. AGREGAR CÓDIGO PARA INICIAR LA VERIFICACIÓN OTP

// Para verificación por teléfono/móvil
do_action ('mo_generate_otp', NULL , NULL , NULL , $número_teléfono,”teléfono”,  NULL , NULL , NULL );

// Para verificación por correo electrónico
do_action ('mo_generate_otp', NULL ,$correo electrónico, NULL ,  NULL ,"correo electrónico",  NULL , NULL , NULL );

PASO 4. AGREGAR CÓDIGO PARA VALIDAR LA OTP (PARA FORMAS AJAX)

Añade el siguiente código , solamente si se está integrando con un formulario AJAX para validar la OTP ingresada por el usuario después del envío del formulario.

hacer_acción ( 'mo_validate_otp' , NULL , $otpEnteredByUser );

PASO 5. AÑADIR ACCIÓN PARA MANEJAR UNA VALIDACIÓN EXITOSA

Utilice el siguiente enlace de acción para determinar qué se debe hacer después de que el usuario haya validado exitosamente la OTP enviada a su teléfono o correo electrónico.

add_action (   'otp_verificación_exitosa' , matriz ( $ This , 'handle_post_verification' ), 10 , 6 );

función  handle_post_verificación ( $redireccionar_a , $usuario_iniciar sesión , $usuario_correo electrónico , $ contraseña ,
                                   $número_teléfono , $datos_extra){

    // Comprueba si hay una sesión activa.

    if   ( session_id ()   ==   ''   ||   ! Está establecido ( $ _SESIÓN ))  sesión_inicio ();

    // regresa si no se inició la verificación otp

    if ( !Está establecido ( $ _SESIÓN [ ' ' ]))   volver;

    //ingrese su código a continuación para procesar el formulario enviado

    .

    .

    .

}

PASO 6. AÑADIR ACCIÓN PARA MANEJAR LA VALIDACIÓN FALLIDA

Utilice el siguiente enlace de acción para determinar qué se debe hacer después de que el usuario no pueda validar la OTP enviada a su teléfono o correo electrónico. O el usuario ingresó una OTP no válida o hubo algún otro error.

add_action (   'otp_verification_failed' , matriz ( $ This , 'handle_failed_verification' ), 10 , 3 );

función  handle_failed_verification ( $usuario_iniciar sesión , $usuario_correo electrónico , $número_teléfono ){

    // Comprueba si hay una sesión activa.

    if   ( session_id ()   ==   ''   ||   ! Está establecido ( $ _SESIÓN ))  sesión_inicio ();

    // regresa si no se inició la verificación otp

    if (! Está establecido ( $ _SESIÓN [ ' ' ]))   volver;

     // esta acción se llama para desarmar la variable de sesión
    hacer_acción ( 'variable_sesión_unset' );  

    // ingresa tu código a continuación para procesar la validación fallida

    .

    .

    .

}

PASO 7. AÑADIR ACCIÓN A LAS VARIABLES DE SESIÓN DESCONFIGADA

Utilice el siguiente enlace de acción para desarmar las variables de sesión que había configurado anteriormente. Esto es importante porque el complemento lo llama desde varios lugares para desarmar las variables de sesión.

add_action (   'variable_sesión_unset' ,  matriz (  $ This ,   'unsetSessionVariables' ),   1 ,   0 );

público   función  unsetSessionVariables (){

    desarmado ( $ _SESIÓN [' mo_customer_validation_site_txID ']);

    desarmado ( $ _SESIÓN [ ' ' ]);

}

ACCIONES

>> otp_verificación_exitosa

/ **
 * Este enlace se activa después de que la OTP ingresada por el usuario se valida correctamente. 
 * Utilice este enlace para modificar/decidir la funcionalidad después de que el usuario haya ingresado al 
 * OTP correcta y el sistema la ha validado exitosamente. 
 * @param $redirect_to la redirección a la URL después del registro de un nuevo usuario
 * @param $user_login el nombre de usuario publicado por el usuario
 * @param $user_email el correo electrónico publicado por el usuario
 * @param $contraseña la contraseña publicada por el usuario 
 * @param $phone_number el número de teléfono publicado por el usuario
 * @param $extra_data cualquier dato adicional publicado por el usuario  
 */
 añadir_acción( 
    'otp_verificación_exitosa', 
    función ($redirect_to,$user_login,$user_email,$contraseña,$número de teléfono,$datos_extra){
       // tu código va aquí 
    },10,6
 );

>> otp_verificación_fallida

/** * Este enlace se activa después de que la OTP ingresada por el usuario se valida correctamente. * Utilice este enlace para modificar/decidir la funcionalidad después de que el usuario haya ingresado la * OTP incorrecta y el sistema la haya validado exitosamente. * @param $user_login el nombre de usuario publicado por el usuario * @param $user_email el correo electrónico publicado por el usuario * @param $phone_number el número de teléfono publicado por el usuario */ add_action( 
    'otp_verification_failed',
    función handle_failed_verification($user_login,$user_email,$phone_number){ //tu código va aquí },10,3
 );

>> unset_session_variable

/ **
 * Este gancho se activa para desarmar todas las variables de la sesión para que * comience un nuevo envío de formulario un nuevo proceso de verificación OTP. * Utilice este enlace para modificar o agregar su propio código para borrar la actividad del usuario * desde la sesión. 
 */
 añadir_acción( 
    'variable_sesión_unset',
    función(){ // tu código va aquí } );

>> mo_registration_show_message

/ **
 * El gancho se activa para mostrar un complemento generado. mensaje al usuario en * el panel de administración. Utilice este enlace para modificar los mensajes que se muestran * al usuario en el panel de administración.
 * @param $content se refiere al contenido del mensaje
 * @param $tipo se refiere al tipo de mensaje
 */
 añadir_acción( 
    'mo_registration_show_message',
    función($content,$type) { // tu código aquí },10,2
 );

>> mo_generate_otp

/ **
 * Este gancho se activa para iniciar la OTP Proceso de verificación. * Utilice este enlace para modificar el proceso de envío de OTP al * teléfono o dirección de correo electrónico de un usuario. Incluso puede llamar a este enlace para * iniciar una solicitud OTP al teléfono o correo electrónico de un usuario.
 * @param cadena $user_login nombre de usuario enviado por el usuario
 * @param string $user_email correo electrónico enviado por el usuario
 * @param cadena $errors variable de error (actualmente no se utiliza)
 * @param string $phone_number número de teléfono enviado por el usuario
 * @param cadena $otp_type verificación de correo electrónico o SMS
 * @param cadena $contraseña contraseña enviada por el usuario
 * @param string $extra_data una matriz que contiene todos los datos adicionales enviados por el usuario
 * @param bool $from_both indica si el usuario puede elegir entre verificación por correo electrónico y por teléfono
 */ agregar_acción(
    'mo_generate_otp',
    función($user_login, $user_email, $errores, $phone_number = "",
             $otp_type="correo electrónico",$contraseña = '', $extra_data = nulo, $from_both = falso){ // tu código va aquí }, 1,8
 );

>> mo_validate_otp

/ **
 * Este enlace se activa para iniciar el proceso de validación de verificación OTP. 
 * Utilice este gancho para modificar el proceso de validando el Token OTP enviado * por el usuario. Incluso puedes iniciar esta acción para validar una OTP * enviada por el usuario.
 * @param string $requestVariable la clave del token otp en el parámetro de publicación
 * @param cadena $otp_token token otp enviado
 */
 añadir_acción(
    'mo_validate_otp',
    función($solicitudVariable,$otp_token){
       // tu código va aquí
    },1,8
 );

>> mo_otp_verification_add_on_controller

/** * Este enlace se activa para mostrar la configuración del complemento. Si desea crear un * complemento personalizado, utilice este enlace para controlar los datos y la vista que * muestra su complemento. */ agregar_acción( 
    'mo_otp_verification_add_on_controller',
    función(){ // tu código va aquí } );

>> mo_otp_verification_delete_addon_options

/** * Este enlace se activa para eliminar la configuración de complementos. Si desea crear un * complemento personalizado, utilice este enlace para activar la * configuración del complemento para que se elimine cuando se elimine el complemento. */ agregar_acción( 
    'mo_otp_verification_delete_addon_options',
    función(){ // tu código va aquí } );

FILTROS

>> get_mo_option

/ **
 * Este filtro se aplica sobre cada valor proveniente de la base de datos. * Enganche a este filtro para modificar los valores provenientes de la base de datos. 
 * @param  $ clave el nombre_opción para recuperar el valor de la base de datos * @param  $prefija el valor de cadena que se antepondrá al nombre_opción antes de recuperar datos
 * @regreso Cordón
 */
 Añadir filtro(
    'opción_get_mo', 
    función($clave,$prefijo) {
       // tu código va aquí // devuelve un valor de la base de datos
    },10,2
 );

>> opción_actualización_mo

/ **  
 * Este filtro se aplica a cada valor antes de colocarlo en la base de datos. * Conéctese a este filtro para modificar los valores antes de que se guarden en la * base de datos de WordPress.
 * @param $ clave el nombre_opción para recuperar el valor de la base de datos * @param $value el valor que se guardará en la base de datos * @param $prefija el valor de la cadena que se antepondrá al nombre_opción antes de recuperar los datos * @regreso Cadena */ 
 Añadir filtro(
    'opción_actualización_mo', 
    función($clave,$valor,$prefijo) { 
       // tu código va aquí
       // devuelve un valor de la base de datos
    },10,3
 );

>> mo_phone_dropdown_selector

/** * Un filtro para modificar la matriz de selectores jQuery para mostrar el * campo desplegable del teléfono. Conéctese a este filtro para modificar o * el campo de teléfono de su propio formulario como selector para mostrar el país * desplegable. * @param  matriz $selector matriz de selectores jQuery * @regreso matriz */ add_filter( 
    'mo_phone_dropdown_selector', 
    función($selector){ // tu código va aquí // devuelve $selector },10,1
 );

>> mo_template_defaults

/** * Este filtro se activa antes de que cada plantilla emergente predeterminada se guarde en el * complemento. Conéctese a este filtro para modificar la plantilla emergente predeterminada antes de que * se guarden en la base de datos. * @param  matriz $templates una matriz de pares clave-valor que consta de todas las plantillas HTML para las ventanas emergentes * @regreso matriz */ add_filter( 
    'mo_template_defaults', 
    función($templates) { // tu código va aquí // return $templates } );
>> mo_template_build

/** * Este filtro se activa para crear cada plantilla emergente y reemplazar las etiquetas * con código HTML antes de mostrarlo en la pantalla a los usuarios. * Enganche a este filtro para modificar o agregar su propio contenido a las ventanas emergentes. * Devuelve el contenido HTML de la ventana emergente en particular. * @param $template el contenido de la plantilla que se va a modificar
 * @param $templateEscriba el tipo de plantilla
 * @param $message el mensaje que se mostrará en la ventana emergente
 * @param $otp_type el tipo otp invocado
 * @param $from_both ¿El usuario tiene la opción de elegir verificación por correo electrónico y SMS en blanco y negro?
 * @regreso Cadena */ add_filter( 
    'mo_template_build',
    función($plantilla,$tipo de plantilla,$mensaje,$otp_type,$from_both){ // tu código va aquí // devuelve contenido HTML },1,5
 );

>> mo_blocked_email_domains

/ **
 * Conéctese a este filtro para modificar la lista de dominios de correo electrónico bloqueados.
 * Este filtro se llama antes de intentar enviar una OTP a la * dirección de correo electrónico del usuario para verificar si el correo electrónico ingresado ha sido incluido en la lista negra * por el administrador del sitio.
 * @param array $blocked_email_domains una lista de dominios de correo electrónico bloqueados
 * @return matriz
 */
 Añadir filtro( 
    'mo_blocked_email_domains', 
    función($dominios_correo_electrónicos_bloqueados) {
        // tu código va aquí
        // devuelve $ dominios_correo_electrónicos_bloqueados
    },10,1
 );

>> mo_teléfonos_bloqueados

/ **
 * Conéctese a este filtro para modificar la lista de números de teléfono bloqueados.
 * Este filtro se llama antes de intentar enviar una OTP al usuario 
 * teléfono para verificar si el número de teléfono ha sido incluido en la lista negra 
 * por el administrador del sitio. Asegúrese de que el número de teléfono esté en formato * internacional, por ejemplo: +1xxxxxxxxx
 * @param  matriz $blocked_phones una lista de dominios de correo electrónico bloqueados
 * @regreso matriz
 */
 Añadir filtro( 
    'mo_blocked_phones', 
    función($teléfonos_bloqueados) {
      // tu código va aquí
      // devuelve $teléfonos_bloqueados
    },10,1
 );

>> mo_filter_phone_antes_api_call

/** * Este filtro se llama antes de que el número de teléfono se pase a la * API de puerta de enlace para enviar un mensaje OTP al usuario. Conéctese a este * filtro para realizar modificaciones en el número de teléfono antes de que * se envíe al SMS Gateway para la entrega OTP. * @param  String $phone el número de teléfono a procesar * @regreso Cadena * * @nota Este filtro solo está disponible para el plan Your Gateway */ add_filter(
    'mo_filter_phone_antes_api_call', 
    función($número_teléfono){ // tu código va aquí // devuelve $número_teléfono },10,1
 );

>> personalizar_otp_url_antes_api_call

/** * Este filtro se llama antes de realizar la llamada API para enviar un mensaje OTP * al usuario. Conéctese a este filtro para realizar modificaciones en la URL * antes de utilizarla para realizar la llamada a la API. * @param  Cadena $url la URL de la puerta de enlace SMS * @param  Cadena $message el mensaje OTP que se enviará al teléfono del usuario * @param  String $phone el número de teléfono a procesar * @regreso String * * @note Este filtro solo está disponible para el plan Your Gateway */ add_filter(
    'personalizar_otp_url_antes_api_call', 
    función($url,$mensaje,$teléfono){ // tu código va aquí // devuelve $url },10,3
  );

>> mo_process_phone

/** * Este filtro se llama para procesar el número de teléfono inmediatamente después del envío del * formulario. Utilice este filtro si desea modificar el número de teléfono * antes de que el formulario y el complemento lo procesen. * @param  String $phone el número de teléfono a procesar * @regreso Cadena */ add_filter(
    'mo_process_phone', 
    función($teléfono){ // tu código va aquí // devuelve $teléfono },10,1
 );

>> es_ajax_form

/** * Este filtro se llama para verificar si el formulario actual para el cual el usuario * está iniciando la verificación OTP realiza una llamada AJAX para envío * o no. Conéctese a este filtro para agregar los datos de su propio formulario o modificar * los datos del formulario existente durante el proceso de verificación OTP. * @param  bool $isAjax Valor verdadero o falso * @regreso booleano */ add_filter(
    'is_ajax_form', 
    función($isAjax){ // tu código va aquí // devuelve $isAjax },10,1
 );

>> is_login_or_social_form

/** * Este filtro se llama para comprobar si el formulario actual para el que el usuario * está iniciando la verificación OTP es un formulario de inicio de sesión o de inicio de sesión social * o no. Conéctese a este filtro para agregar los datos de su propio formulario o modificar * los datos del formulario existente durante el proceso de verificación OTP. * @param  bool $isLoginOrSocialForm Valor verdadero o falso * @regreso booleano */ add_filter(
    'is_login_or_social_form', 
    función($isLoginOrSocialForm){ // tu código va aquí // devuelve $isAjax },10,1
 );

>> mo_curl_page_url

/** * Este filtro se llama para modificar la URL de la página actual. Este filtro * se llama durante el proceso de verificación OTP para realizar un seguimiento de la página * donde el usuario inició la verificación OTP. El usuario es redirigido a esta * página cuando hace clic en el botón Volver en la página emergente OTP. * Conéctese a este filtro para modificar la URL de la página actual. * @param  Cadena $pageURL la URL de la página actual * @regreso Cadena */ add_filter(
    'mo_curl_page_url', 
    función($pageURL){ // tu código va aquí // devuelve $pageURL },10,1
 );