pre_untrash_post
Filters whether a post untrashing should take place.
Usage
add_filter( 'pre_untrash_post', 'wp_kama_pre_untrash_post_filter', 10, 3 ); /** * Function for `pre_untrash_post` filter-hook. * * @param bool|null $untrash Whether to go forward with untrashing. * @param WP_Post $post Post object. * @param string $previous_status The status of the post at the point where it was trashed. * * @return bool|null */ function wp_kama_pre_untrash_post_filter( $untrash, $post, $previous_status ){ // filter... return $untrash; }
- $untrash(true|false|null)
- Whether to go forward with untrashing.
- $post(WP_Post)
- Post object.
- $previous_status(string)
- The status of the post at the point where it was trashed.
Changelog
Since 4.9.0 | Introduced. |
Since 5.6.0 | Added the $previous_status parameter. |
Where the hook is called
wp-includes/post.php 3824
$check = apply_filters( 'pre_untrash_post', null, $post, $previous_status );