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_8307', 10, 2 );
function filter_function_name_8307( $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 881
return apply_filters( 'post_password_required', $required, $post );
wp-includes/post-template.php 854
return apply_filters( 'post_password_required', false, $post );
wp-includes/post-template.php 859
return apply_filters( 'post_password_required', true, $post );
Where in WP core the hook is used WordPress
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 1769
add_filter( 'post_password_required', '__return_false' );
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 1781
remove_filter( 'post_password_required', '__return_false' );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 1755
add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 1793
remove_filter( 'post_password_required', array( $this, 'check_password_required' ) );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 357
add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 373
remove_filter( 'post_password_required', array( $this, 'check_password_required' ) );
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 488
add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 );