post_password_required filter
Filters whether a post requires the user to supply a password.
apply_filters( 'post_password_required', bool $required, WP_Post $post )
Parameters
- $required : (bool) 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.
- $post : (WP_Post) Post object.
Description
This is filter hook , its filter whether a post requires the user to supply a password.
Its consists of two parameter, one is $required and another is $post Object.
Live Example
To run the hook, copy the example below.
$false = apply_filters( 'post_password_required', $false, $post ); if ( !empty( $false ) ) { // everything has led up to this point... }
The following example is for adding a hook callback.
// define the post_password_required callback function filter_post_password_required( $false, $post ) { // make filter magic happen here... return $false; }; // add the filter add_filter( 'post_password_required', 'filter_post_password_required', 10, 2 );
To remove a hook callback, use the example below.
// remove the filter remove_filter( 'post_password_required', 'filter_post_password_required', 10, 2 );