get_post_format( int|WP_Post|null $post = null )

Retrieve the format slug for a post

Parameters

$post

(int|WP_Post|null) (Optional) Post ID or post object. Defaults to the current post in the loop.

Default value: null

Return

(string|false) The format if successful. False otherwise.

More Information

This will usually be called in the the loop, but can be used anywhere if a post ID is provided.

The set of currently defined formats are:

aside
chat
gallery
link
image
quote
status
video
audio

Note also that the default format (i.e., a normal post) returns false, but this is also referred in some places as the ‘standard’ format. In some cases, developers may wish to do something like the following to maintain consistency:

$format = get_post_format() ? : 'standard';

Source

File: wp-includes/post-formats.php

function get_post_format( $post = null ) {
	$post = get_post( $post );

	if ( ! $post ) {
		return false;
	}

	if ( ! post_type_supports( $post->post_type, 'post-formats' ) ) {
		return false;
	}

	$_format = get_the_terms( $post->ID, 'post_format' );

	if ( empty( $_format ) ) {
		return false;
	}

	$format = reset( $_format );

	return str_replace( 'post-format-', '', $format->slug );
}

Uses

Uses	Description
wp-includes/category-template.php: get_the_terms()	Retrieves the terms of the taxonomy that are attached to the post.
wp-includes/post.php: post_type_supports()	Check a post type’s support for a given feature.
wp-includes/post.php: get_post()	Retrieves post data given a post ID or post object.

Used By

Used By	Description
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()	Prepares a single post output for response.
wp-includes/template.php: get_embed_template()	Retrieves an embed template path in the current or parent template.
wp-admin/includes/template.php: get_inline_data()	Adds hidden fields with the data for use in the inline editor for posts and pages.
wp-admin/includes/meta-boxes.php: post_format_meta_box()	Display post format form elements.
wp-includes/post-template.php: get_post_class()	Retrieves an array of the class names for the post container element.
wp-includes/post-template.php: get_body_class()	Retrieves an array of the class names for the body element.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getPost()	Retrieve post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getRecentPosts()	Retrieve list of recent posts.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_post()	Prepares post data for return in an XML-RPC object.
wp-includes/class-wp-editor.php: _WP_Editors::editor_settings()

Changelog

Version	Description
3.1.0	Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_post_format