Question

post_password_required( int|WP_Post|null $post = null )

Whether post requires password and correct password has been provided.

---

description

---

参数

$post

(int|WP_Post|null) (Optional) An optional post. Global $post used if not provided.

Default value: null

---

返回值

(bool) false if a password is not required or the correct password cookie is present, true otherwise.

---

源代码

File: wp-includes/post-template.php

function post_password_required( $post = null ) {
	$post = get_post($post);

	if ( empty( $post->post_password ) ) {
		/** This filter is documented in wp-includes/post.php */
		return apply_filters( 'post_password_required', false, $post );
	}

	if ( ! isset( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] ) ) {
		/** This filter is documented in wp-includes/post.php */
		return apply_filters( 'post_password_required', true, $post );
	}

	require_once ABSPATH . WPINC . '/class-phpass.php';
	$hasher = new PasswordHash( 8, true );

	$hash = wp_unslash( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] );
	if ( 0 !== strpos( $hash, '$P$B' ) ) {
		$required = true;
	} else {
		$required = ! $hasher->CheckPassword( $post->post_password, $hash );
	}

	/**
	 * Filters whether a post requires the user to supply a password.
	 *
	 * @since 4.7.0
	 *
	 * @param bool    $required 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.
	 * @param WP_Post $post     Post data.
	 */
	return apply_filters( 'post_password_required', $required, $post );
}

---

更新日志

Version	description
2.7.0	Introduced.

---

相关函数

Uses

• wp-includes/post-template.php: post_password_required
• wp-includes/formatting.php: wp_unslash()
• wp-includes/plugin.php: apply_filters()
• wp-includes/post.php: get_post()

---

Used By

• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()
• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_database()
• wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php: WP_REST_Comments_Controller::check_read_post_permission()
• wp-includes/comment.php: wp_handle_comment_submission()
• wp-includes/feed.php: rss_enclosure()
• wp-includes/feed.php: atom_enclosure()
• wp-includes/post-template.php: get_the_content()
• wp-includes/post-template.php: get_the_excerpt()
• wp-includes/post-template.php: get_post_class()
• wp-includes/comment-template.php: comments_popup_link()
Show 5 more used by Hide more used by

---

User Contributed Notes