is_post_status_viewable filter
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.
To use is_post_status_viewable filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.
We at Flipper Code, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.
In the below live example, we have defined a function modify_is_post_status_viewable_defaults which takes 2 parameters and we registered using add_filter. The first parameter is_post_status_viewable is name of the hook, The second parameter modify_is_post_status_viewable_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.
Sometime, you have to remove a registered hook so you can use remove_filter to remove is_post_status_viewable filter.
Parameters
- $is_viewable : (bool) Whether the post status is “viewable” (strict type).
- $post_status : (stdClass) Post status object.
Below are the 2 parameters are required to use this hook.
Live Example
apply_filters( 'is_post_status_viewable', bool $is_viewable, stdClass $post_status )
Below is an example how you can use this hook.
function modify_is_post_status_viewable_defaults($is_viewable, $post_status) {
// Update the $is_viewable variable according to your website requirements and return this variable. You can modify the $is_viewable variable conditionally too if you want.
return $is_viewable;
}
// add the filter
add_filter( "is_post_status_viewable", "modify_is_post_status_viewable_defaults", 10, 2 );
To remove a hook callback, use the example below.
remove_filter( "is_post_status_viewable", "modify_is_post_status_viewable_defaults", 10, 2 );
Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.
Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.
