Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: post_password_required

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

This hook occurs 3 times in this file.

Line Code
824  *
825  * @param int|WP_Post|null $post An optional post. Global $post used if not provided.
826  * @return bool false if a password is not required or the correct password cookie is present, true otherwise.
827  */
828 function post_password_required( $post = null ) {
829      $post = get_post( $post );
830
831      if ( empty( $post->post_password ) ) {
832           /** This filter is documented in wp-includes/post-template.php */
833           return apply_filters( 'post_password_required', false, $post );
834      }
835
836      if ( ! isset( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] ) ) {
837           /** This filter is documented in wp-includes/post-template.php */
838           return apply_filters( 'post_password_required', true, $post );
839      }
840
841      require_once ABSPATH . WPINC . '/class-phpass.php';
842      $hasher = new PasswordHash( 8, true );
843
844      $hash = wp_unslash( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] );
845      if ( 0 !== strpos( $hash, '$P$B' ) ) {
846           $required = true;
847      } else {
 
Line Code
851      /**
852       * Filters whether a post requires the user to supply a password.
853       *
854       * @since 4.7.0
855       *
856       * @param bool    $required Whether the user needs to supply a password. True if password has not been
857       *                          provided or is incorrect, false if password has been supplied or is not required.
858       * @param WP_Post $post     Post data.
859       */
860      return apply_filters( 'post_password_required', $required, $post );
861 }
862
863 //
864 // Page Template Functions for usage in Themes
865 //
866
867 /**
868  * The formatted output of a list of pages.
869  *