post_password_required filter-hook . WP 4.7.0
Filters whether a post requires the user to supply a password.
Usage
add_filter( 'post_password_required', 'filter_function_name_5070', 10, 2 );
function filter_function_name_5070( $required, $post ){
// filter...
return $required;
}
- $required(true/false)
- 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 data.
Changelog
| Since 4.7.0 | Introduced. |
Where the hook is called
post_password_required
wp-includes/post-template.php 871
return apply_filters( 'post_password_required', $required, $post );
wp-includes/post-template.php 844
return apply_filters( 'post_password_required', false, $post );
wp-includes/post-template.php 849
return apply_filters( 'post_password_required', true, $post );
Where the hook is used (in WP core)
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 1594
add_filter( 'post_password_required', '__return_false' );
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 1606
remove_filter( 'post_password_required', '__return_false' );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 1523
add_filter( 'post_password_required', '__return_false' );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 1550
remove_filter( 'post_password_required', '__return_false' );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 303
add_filter( 'post_password_required', '__return_false' );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 319
remove_filter( 'post_password_required', '__return_false' );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 417
add_filter( 'post_password_required', '__return_false' );