has_post_format( string|array $format = array(), WP_Post|int|null $post = null )

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


Description Description


Parameters Parameters

$format

(string|array) (Optional) The format or formats to check.

Default value: array()

$post

(WP_Post|int|null) (Optional) The post to check. If not supplied, defaults to the current post if used in the loop.

Default value: null


Top ↑

Return Return

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


Top ↑

Source Source

File: wp-includes/post-formats.php

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

Changelog
Version Description
3.1.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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