WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

post_password_required()

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

In this article

Back to top

Determines whether the post requires password and whether a correct password has been provided.

Parameters

$postint|WP_Post|nulloptional
An optional post. Global $post used if not provided.

Default:null

Return

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

Source

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

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

	if ( ! isset( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] ) ) {
		/** This filter is documented in wp-includes/post-template.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 ( ! str_starts_with( $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 object.
	 */
	return apply_filters( 'post_password_required', $required, $post );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘post_password_required’, bool $required, WP_Post $post )

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

UsesDescription
wp_unslash()wp-includes/formatting.php

Removes slashes from a string or recursively removes slashes from strings within an array.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 1 moreShow less
Used byDescription
_block_bindings_post_meta_get_value()wp-includes/block-bindings/post-meta.php

Gets value for Post Meta source.

WP_REST_Posts_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Prepares a single post output for response.

WP_REST_Posts_Controller::prepare_item_for_database()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Prepares a single post for create or update.

WP_REST_Comments_Controller::check_read_post_permission()wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Checks if the post can be read.

wp_handle_comment_submission()wp-includes/comment.php

Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.

WP_Posts_List_Table::column_title()wp-admin/includes/class-wp-posts-list-table.php

Handles the title column output.

WP_List_Table::comments_bubble()wp-admin/includes/class-wp-list-table.php

Displays a comment count bubble.

wp_dashboard_recent_comments()wp-admin/includes/dashboard.php

Show Comments section.

WP_Comments_List_Table::single_row()wp-admin/includes/class-wp-comments-list-table.php
rss_enclosure()wp-includes/feed.php

Displays the rss enclosure for the current post.

atom_enclosure()wp-includes/feed.php

Displays the atom enclosure for the current post.

get_the_content()wp-includes/post-template.php

Retrieves the post content.

get_the_excerpt()wp-includes/post-template.php

Retrieves the post excerpt.

get_post_class()wp-includes/post-template.php

Retrieves an array of the class names for the post container element.

wp_xmlrpc_server::wp_newComment()wp-includes/class-wp-xmlrpc-server.php

Creates a new comment.

comments_popup_link()wp-includes/comment-template.php

Displays the link to the comments for the current post ID.

get_comment_excerpt()wp-includes/comment-template.php

Retrieves the excerpt of the given comment.

Show 12 moreShow less

Changelog

VersionDescription
2.7.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    MrsJessicaSimpson
    You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note

    I looked long and hard in trying to find a working example of his function, (couldn’t!)
    The code below works, and it works well.

    Note 1: Without getting, (and using the post->ID), then the post_password_required function doesn’t work.
    Note 2: Something else you have to watch is cookies being set once the password has been used once, makes debugging a nightmare, (tip), use an Incognito Window when testing out your code.
    Note 3: I have broken with tradition here, and opened (the-Loop) with wide braces instead of the endwhile: condition, I personally find it easier to follow.

    Hope it helps.

    <?php

$pass_masterPost = get_post();
if ( post_password_required(  $pass_masterPost->ID ) )
{
    echo get_the_password_form();
    echo '<p>THIS POST IS PASSWORD PROTECTED: PLEASE ENTER IT!</p>';
}
else
{
    if ( have_posts() )
    { 
        while ( have_posts() ) 
        {        
            the_post();
            the_content();
			echo '<hr>';
         }    
    }
    else
    {
        echo '<p>Nothing Found!</p>';
    }
}
?>

You must log in before being able to contribute a note or feedback.