Changeset 52043

Timestamp:

11/08/2021 03:20:51 PM (3 years ago)

Author:

hellofromTonya

Message:

Posts/Post Types: Introduce 'is_post_status_viewable ' filter in is_post_status_viewable().

Introduces a new filter 'is_post_status_viewable' which allows overriding the check.

The function's return signature is a boolean type. This commit ensures
the return signature remains unchanged by requirinng a strict boolean
type of the returned filtered value.

Why?

• To maintain this signature and backwards-compatibility.
• To future prepare for PHP 8.1 and beyond.

An explanation is included in the filter's DocBlock.

Follow-up to [50130].

Props audrasjb, hellofromTonya, peterwilsoncc.
Fixes #54375.

File:

• trunk/src/wp-includes/post.php (modified) (2 diffs)

trunk/src/wp-includes/post.php

@@ -2158 +2158 @@
  *
  * @since 5.7.0
+ * @since 5.9.0 Added `is_post_status_viewable` hook to filter the result.
  *
  * @param string|stdClass $post_status Post status name or object.
@@ -2178 +2179 @@
     }
 
-    return $post_status->publicly_queryable || ( $post_status->_builtin && $post_status->public );
+    $is_viewable = $post_status->publicly_queryable || ( $post_status->_builtin && $post_status->public );
+
+    /**
+     * Filters whether a post status is considered "viewable".
+     *
+     * The returned filtered value must be a boolean type to ensure
+     * `is_post_status_viewable()` only returns a boolean. This strictness
+     * is by design to maintain backwards-compatibility and guard against
+     * potential type errors in PHP 8.1+. Non-boolean values (even falsey
+     * and truthy values) will result in the function returning false.
+     *
+     * @since 5.9.0
+     *
+     * @param bool     $is_viewable Whether the post status is "viewable" (strict type).
+     * @param stdClass $post_status Post status object.
+     */
+    return true === apply_filters( 'is_post_status_viewable', $is_viewable, $post_status );
 }