钩子文档

post_password_required

💡 云策文档标注

概述

post_password_required 是一个 WordPress 过滤器,用于控制文章是否需要用户提供密码访问。它允许开发者根据条件修改密码需求状态。

关键要点

  • 这是一个过滤器钩子,用于过滤文章密码需求状态。
  • 接受两个参数:$required(布尔值,表示是否需要密码)和 $post(WP_Post 对象)。
  • 在 post_password_required() 函数中被调用,用于确定文章密码需求和正确性。
  • 从 WordPress 4.7.0 版本开始引入。

📄 原文内容

Filters whether a post requires the user to supply a password.

Parameters

$requiredbool
Whether the user needs to supply a password. True if password has not been provided or is incorrect, false if password has been supplied or is not required.
$postWP_Post
Post object.

Source

return apply_filters( 'post_password_required', $required, $post );

Changelog

Version Description
4.7.0 Introduced.