Saltar al contenido principal
Los plugins de WordPress se pueden ampliar para adaptarse a sus necesidades específicas mediante acciones y filtros que ejecutan código personalizado en puntos concretos durante el tiempo de ejecución. En este documento se describen los hooks disponibles en el plugin de WordPress Login by Auth0. Revisaremos y aprobaremos con gusto nuevos filtros y acciones que le permitan ampliar aún más la integración con este plugin. Para obtener más información, consulte la sección Contributing del README en el repositorio de GitHub del plugin.

​
Acciones de WordPress

Las acciones de WordPress ejecutan código personalizado en puntos específicos durante el procesamiento. Para obtener más información sobre las acciones de WordPress, consulta WordPress Plugin Handbook: Actions en wordpress.org.

​
auth0_before_login

Esta acción se ejecuta en WP_Auth0_LoginManager después de que un usuario se haya autenticado correctamente, pero antes de iniciar sesión en WordPress. Puede usarse para detener el proceso de inicio de sesión si es necesario mediante wp_die() o lanzando una excepción.

​
auth0_user_login

Esta acción se ejecuta en WP_Auth0_LoginManager después de que un usuario se haya autenticado correctamente y haya iniciado sesión en WordPress. Se puede usar para establecer valores de metadatos específicos, enviar notificaciones o notificar a otros servicios.

​
wpa0_user_created

Esta acción se ejecuta en WP_Auth0_Users justo después de que se haya creado correctamente un usuario de WordPress. Puede usarse para modificar los valores del usuario, establecer metadatos de usuario adicionales o activar otras acciones relacionadas con usuarios nuevos.

​
Filtros

Los filtros en WordPress también ejecutan código personalizado en puntos específicos del procesamiento, pero siempre devuelven un valor modificado del mismo tipo que el valor recibido. Para obtener más información sobre los filtros, consulta WordPress Plugin Handbook: Filters en wordpress.org.

​
auth0_create_user_data

Este filtro se puede usar para modificar la matriz de datos de usuario al crear un nuevo usuario en WordPress a partir de un usuario de Auth0 entrante. Recibe 2 parámetros:
  • $user_data son los datos de usuario extraídos del perfil de Auth0.
  • $userinfo es el perfil del usuario de Auth0.
Este filtro siempre debe devolver una matriz de datos que se pasará a la función principal wp_insert_user().

​
auth0_get_wp_user

Este filtro se invoca después de que el plugin encuentra el usuario relacionado para iniciar sesión (según el user_id de Auth0) y se usa para reemplazar el comportamiento predeterminado por reglas de coincidencia personalizadas (por ejemplo, hacer que siempre coincida por correo electrónico). Si el filtro devuelve null, buscará por correo electrónico. Para obtener más información, consulta Integrate with WordPress.

​
auth0_verify_email_page

Este filtro se ejecuta en WP_Auth0_Email_Verification para cambiar el HTML que se muestra cuando un usuario que inicia sesión necesita verificar su correo electrónico antes de obtener acceso al sitio. Tenga en cuenta que este HTML se pasa a wp_die(), donde se modifica antes de mostrarse (consulte la definición de _default_wp_die_handler() en el core para obtener más información).

​
auth0_get_auto_login_connection

Este filtro se usa en WP_Auth0_LoginManager para modificar la conexión que se utiliza en el proceso de inicio de sesión automático. La configuración de wp-admin se obtiene y luego se pasa por este filtro.

​
wp_auth0_get_option

Este filtro lo usan las funciones y los métodos que obtienen opciones para modificar el valor de salida.

​
auth0_migration_ws_authenticated

Este filtro se usa en WP_Auth0_Routes para modificar el objeto WP_User, que se codifica en JSON y se devuelve a Auth0 durante la migración de un usuario.

​
wpa0_should_create_user

Este filtro se usa en WP_Auth0_Users para decidir si debe crearse un usuario. El valor inicial que se pasa es TRUE. Si se devuelve FALSE por cualquier motivo, se rechazará el registro y el usuario que intenta registrarse verá un mensaje de error (WP_Auth0_UsersRepo::create()).

​
auth0_login_css

Este filtro se utiliza para modificar el CSS de la página de inicio de sesión, incluido el propio widget de inicio de sesión. Este filtro se ejecuta antes de recuperar el CSS de la página de configuración de wp-admin.

​
auth0_login_form_tpl

Filtra la plantilla usada para el formulario de inicio de sesión de Auth0. Debe devolver la ruta a un archivo que contenga HTML y reemplace el contenido de wp-content/plugins/auth0/templates/auth0-login-form.php. El JS estándar de inicialización de Lock busca un atributo ID con el valor auth0-login-form para instanciar el formulario de inicio de sesión, así que asegúrate de que esté presente o sustituye el archivo wp-content/plugins/auth0/assets/js/lock-init.js por uno propio.

​
auth0_settings_fields

Este filtro se utiliza para modificar un campo de formulario existente o para agregar uno nuevo. Debe devolver un arreglo $options modificado con sus cambios o incorporaciones. Los campos nuevos deben tener una función callback para el campo, como se muestra a continuación.

​
auth0_auth_scope

Este filtro permite a los desarrolladores añadir o cambiar el scope solicitado durante el inicio de sesión. Se puede usar para añadir claims personalizadas o solicitar un . Use este filtro para modificar el nombre de la cookie que se usa para validar el . Consulte el filtro auth0_state_cookie_name a continuación para ver un ejemplo. Use este filtro para modificar el nombre de la cookie que se utiliza para el valor del parámetro state. Puede añadir un prefijo o un sufijo, o sustituir por completo la cadena. Para obtener más información sobre el parámetro state, consulte Prevent Attacks and Redirect Users with OAuth 2.0 State Parameters. Asegúrese de usar caracteres válidos en cualquier modificación que realice: 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: ( ) < > @ , ; : \ " / ? = { }. Para obtener más información sobre el encabezado de respuesta HTTP Set-Cookie, consulte Set-Cookie in MDN Web Docs.

​
auth0_settings_constant_prefix

Utilice este filtro para cambiar el prefijo de la constante que se usa para sobrescribir la configuración del plugin. Tenga en cuenta que este filtro debe ejecutarse antes de que se cargue el plugin de Auth0, por lo que se debe ubicar en un plugin MU. Para obtener más información sobre los plugins MU, lea Must Use Plugins on wordpress.org.

​
auth0_authorize_url_params

Este filtro permite a los desarrolladores ajustar los parámetros del endpoint /authorize según sea necesario. La función debe devolver un diccionario con parámetros de URL. Para obtener más información sobre cómo se usan estos parámetros, consulte Authentication API Explorer: Inicio de sesión.

​
auth0_authorize_url

Este filtro permite a los desarrolladores modificar la URL completa de /authorize antes de usarla. La función debe devolver una URL válida en forma de cadena. Para obtener más información sobre cómo se utiliza esta URL, consulte Authentication API Explorer: Inicio de sesión.

​
auth0_die_on_login_output

Este filtro permite modificar o reemplazar el contenido HTML que se pasa a wp_die() cuando se produce un error durante el inicio de sesión. Este filtro no afecta al contenido de verificación del correo electrónico (consulte auth0_verify_email_page).

​
auth0_coo_auth0js_url

Este filtro le permite reemplazar la URL predeterminada del CDN de Auth0.js al cargar la página de respaldo de COO.

​
auth0_slo_return_to

Este filtro te permite sobrescribir la URL returnTo predeterminada al cerrar sesión en Auth0.

​
auth0_logout_url

Este filtro le permite anular la URL de cierre de sesión de Auth0. Para obtener más información sobre cómo se usa, consulte Logout.

​
auth0_use_management_api_for_userinfo

Este filtro determina si deben usarse los datos del perfil del usuario recuperados de la cuando no se utiliza el flujo de inicio de sesión implícito. Devuelve un valor booleano true (predeterminado) para usar la API, o false para usar el .

​
auth0_lock_options

Este filtro se puede utilizar para modificar las opciones del formulario de inicio de sesión integrado de Lock que se usa en los shortcodes, widgets y en la página wp-login.php cuando Features > Page está desactivada.

​
auth0_jwt_leeway

Este filtro permite ajustar el margen de tolerancia que se utiliza para validar los tokens de ID y debe devolver un número entero de segundos.

​
auth0_jwt_max_age

Este filtro le permite ajustar el parámetro de URL max_age que se envía en la URL de autorización.

​
auth0_authorize_state

Este filtro permite filtrar los datos de estado antes de codificarlos y usarlos para el inicio de sesión. Estos datos se verificarán después de que el inicio de sesión se complete correctamente y se proporcionarán tal cual para su uso.

​
Más información