has_post_format( string|string[] $format = array(), WP_Post|int|null $post = null ): bool

Check if a post has any of the given formats, or any format.


Parameters

$format string|string[] Optional
The format or formats to check.

Default: array()

$post WP_Post|int|null Optional
The post to check. Defaults to the current post in the loop.

Default: null


Top ↑

Return

bool True if the post has any of the given formats (or any format, if no format specified), false otherwise.


Top ↑

More Information

Usage:
$format = has_post_format($format, $post_id);

Top ↑

Source

File: wp-includes/post-formats.php. View all references

function has_post_format( $format = array(), $post = null ) {
	$prefixed = array();

	if ( $format ) {
		foreach ( (array) $format as $single ) {
			$prefixed[] = 'post-format-' . sanitize_key( $single );
		}
	}

	return has_term( $prefixed, 'post_format', $post );
}


Top ↑

Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes

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