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

Parameters

$formatstring|string[]optional

The format or formats to check. Default empty array.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.

Uses · 2

• sanitize_key()Sanitizes a string key.
• has_term()Checks if the current post has any of given terms.

Used by · 4

• Twenty_Fourteen_Ephemera_Widget::widget()Outputs the HTML for this widget.
• twentythirteen_content_width()Adjusts content_width value for video post formats and attachment templates.
• twentythirteen_entry_date()Prints HTML with date information for current post.
• twentythirteen_entry_meta()Prints HTML with meta information for current post: categories, tags, permalink, author, and date.

Source

View on Trac ↗View on GitHub ↗

49function has_post_format( $format = array(), $post = null ) {50	$prefixed = array();51 52	if ( $format ) {53		foreach ( (array) $format as $single ) {54			$prefixed[] = 'post-format-' . sanitize_key( $single );55		}56	}57 58	return has_term( $prefixed, 'post_format', $post );59}

History

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/post-formats.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.