WP_Post::filter( string $filter ): WP_Post|false

Applies the provided context filter for the current post.

Description

If the requested filter was already applied, then it returns without any changes.

If the ‘raw’ filter is supplied, then a new instance of the post is obtained and this method may return false in case the underlying post was deleted.

Parameters

$filterstringrequired: Filter.

Return

WP_Post|false

Source

public function filter( $filter ) {
	if ( $this->filter === $filter ) {
		return $this;
	}

	if ( 'raw' === $filter ) {
		return self::get_instance( $this->ID );
	}

	return sanitize_post( $this, $filter );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Post::get_instance()`wp-includes/class-wp-post.php`	Retrieve WP_Post instance.
sanitize_post()`wp-includes/post.php`	Sanitizes every post field.

Changelog

Version	Description
3.5.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.