Changeset 52024

Timestamp:

11/05/2021 11:00:44 PM (3 years ago)

Author:

hellofromTonya

Message:

Posts/Post Types: Add filter to is_post_type_viewable().

Introduces a new filter 'is_post_type_viewable' which allows overriding the check. The expected filtered value is a boolean. As filtered values can change, including the data type, this commit includes a is_bool() check, thus ensuring backwards-compatibility.

Follow-up to [33666], [36402].

Props audrasjb, deepaklalwani, hellofromTonya, peterwilsoncc, powerbuoy, sergeybiryukov.
Fixes #49628.

File:

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

trunk/src/wp-includes/post.php

@@ -2087 +2087 @@
  * @since 4.5.0 Added the ability to pass a post type name in addition to object.
  * @since 4.6.0 Converted the `$post_type` parameter to accept a `WP_Post_Type` object.
+ * @since 5.9.0 Added `is_post_type_viewable` hook to filter the result.
  *
  * @param string|WP_Post_Type $post_type Post type name or object.
@@ -2103 +2104 @@
     }
 
-    return $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
+    $is_viewable = $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
+
+    /**
+     * Filters whether a post type is considered "viewable".
+     *
+     * @since 5.9.0
+     *
+     * @param bool         $is_viewable Whether the post type is "viewable".
+     * @param WP_Post_Type $post_type   Post type object.
+     */
+    $is_viewable = apply_filters( 'is_post_type_viewable', $is_viewable, $post_type );
+
+    // Make sure the filtered value is a boolean type before returning it.
+    if ( ! is_bool( $is_viewable ) ) {
+        return false;
+    }
+
+    return $is_viewable;
 }