has_post_format() – Function | Developer.WordPress.org

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

Parameters

$formatstring|string[]optional: The format or formats to check.
Default:array()
$postWP_Post|int|nulloptional: The post to check. Defaults to the current post in the loop.
Default:null

Return

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

More Information

Usage:

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

Source

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 );
}

View all references View on Trac View on GitHub

Uses	Description
has_term()`wp-includes/category-template.php`	Checks if the current post has any of given terms.
sanitize_key()`wp-includes/formatting.php`	Sanitizes a string key.

Changelog

Version	Description
3.1.0	Introduced.

User Contributed Notes

Skip to note 2 content

Steven Lin 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Example migrated from Codex:
```
<?php
/*
 * Do something if the post format is a gallery
 */

if ( has_post_format('gallery') ) {
  // Do something
}
?>
```
Log in to add feedback

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

In this article

Parameters

Return

More Information

Usage:

Source

Changelog

User Contributed Notes