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
841  *
842  * @param int|WP_Post|null $post An optional post. Global $post used if not provided.
843  * @return bool false if a password is not required or the correct password cookie is present, true otherwise.
844  */
845 function post_password_required( $post = null ) {
846      $post = get_post( $post );
847
848      if ( empty( $post->post_password ) ) {
849           /** This filter is documented in wp-includes/post-template.php */
850           return apply_filters( 'post_password_required', false, $post );
851      }
852
853      if ( ! isset( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] ) ) {
854           /** This filter is documented in wp-includes/post-template.php */
855           return apply_filters( 'post_password_required', true, $post );
856      }
857
858      require_once ABSPATH . WPINC . '/class-phpass.php';
859      $hasher = new PasswordHash( 8, true );
860
861      $hash = wp_unslash( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] );
862      if ( 0 !== strpos( $hash, '$P$B' ) ) {
863           $required = true;
864      } else {
 
Line Code
868      /**
869       * Filters whether a post requires the user to supply a password.
870       *
871       * @since 4.7.0
872       *
873       * @param bool    $required Whether the user needs to supply a password. True if password has not been
874       *                          provided or is incorrect, false if password has been supplied or is not required.
875       * @param WP_Post $post     Post data.
876       */
877      return apply_filters( 'post_password_required', $required, $post );
878 }
879
880 //
881 // Page Template Functions for usage in Themes
882 //
883
884 /**
885  * The formatted output of a list of pages.
886  *