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', 'wp_kama_post_password_required_filter', 10, 2 );

/**
 * Function for `post_password_required` filter-hook.
 * 
 * @param bool    $required 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.
 * @param WP_Post $post     Post object.
 *
 * @return bool
 */
function wp_kama_post_password_required_filter( $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 object.

Changelog

Where the hook is called

return apply_filters( 'post_password_required', $required, $post );

return apply_filters( 'post_password_required', false, $post );

return apply_filters( 'post_password_required', true, $post );

Where the hook is used in WordPress

add_filter( 'post_password_required', '__return_false' );

remove_filter( 'post_password_required', '__return_false' );

add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 );

remove_filter( 'post_password_required', array( $this, 'check_password_required' ) );

add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 );

remove_filter( 'post_password_required', array( $this, 'check_password_required' ) );

add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 );