Changeset 38603

Timestamp:

09/14/2016 09:27:16 PM (8 years ago)

Author:

jorbin

Message:

Posts: Add filter to allow overriding post_password_required return

Post Passwords are incredibly inflexible. One Password per site at a time and other limitations that can't really be changed without a backwards compatibility break. This adds the ability for sites to change the password behavior such as doing per post passwords or allowing multiple passwords to be set in a browser. The possibilities are YUGE.

Additionally, it allows for a behavior other than returning a html form when a password is needed. This is important for non website use cases (such as in a restful API).

Fixes #38056. See #16483.
Props rmccue.

File:

• trunk/src/wp-includes/post-template.php (modified) (1 diff)

trunk/src/wp-includes/post-template.php

@@ -780 +780 @@
     $post = get_post($post);
 
-    if ( empty( $post->post_password ) )
-        return false;
-
-    if ( ! isset( $_COOKIE['wp-postpass_' . COOKIEHASH] ) )
-        return true;
+    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 );
+    }
 
     $hasher = new PasswordHash( 8, true );
 
     $hash = wp_unslash( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] );
-    if ( 0 !== strpos( $hash, '$P$B' ) )
-        return true;
-
-    return ! $hasher->CheckPassword( $post->post_password, $hash );
+    if ( 0 !== strpos( $hash, '$P$B' ) ) {
+        $required = true;
+    } else {
+        $required = ! $hasher->CheckPassword( $post->post_password, $hash );
+    }
+
+    /**
+     * Filter whether a post requires the user to supply a password.
+     *
+     * @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 );
 }