钩子文档

auth_redirect

💡 云策文档标注

概述

auth_redirect 是一个 WordPress 钩子,在用户身份验证重定向之前触发。它允许开发者在重定向到登录页面前执行自定义操作。

关键要点

  • 这是一个动作钩子,用于在 auth_redirect() 函数执行重定向前触发。
  • 钩子传递一个参数:$user_id,表示用户 ID。
  • 钩子自 WordPress 2.8.0 版本引入。

代码示例

do_action( 'auth_redirect', $user_id );

注意事项

  • 此钩子与 auth_redirect() 函数相关,该函数检查用户是否登录,未登录则重定向到登录页面。
  • 开发者可以添加自定义函数来响应此钩子,例如记录日志或修改重定向行为。

📄 原文内容

Fires before the authentication redirect.

Parameters

$user_idint
User ID.

Source

do_action( 'auth_redirect', $user_id );

Changelog

Version Description
2.8.0 Introduced.