WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_post_format()

get_post_format( int|WP_Post|null $post = null ): string|false

In this article

Back to top

Retrieve the format slug for a post

Parameters

$postint|WP_Post|nulloptional
Post ID or post object. Defaults to the current post in the loop.

Default: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

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

View all references View on Trac View on GitHub

UsesDescription
get_the_terms()wp-includes/category-template.php

Retrieves the terms of the taxonomy that are attached to the post.

post_type_supports()wp-includes/post.php

Checks a post type’s support for a given feature.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 1 moreShow less
Used byDescription
WP_REST_Posts_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Prepares a single post output for response.

get_embed_template()wp-includes/template.php

Retrieves an embed template path in the current or parent template.

get_inline_data()wp-admin/includes/template.php

Adds hidden fields with the data for use in the inline editor for posts and pages.

post_format_meta_box()wp-admin/includes/meta-boxes.php

Displays post format form elements.

get_post_class()wp-includes/post-template.php

Retrieves an array of the class names for the post container element.

get_body_class()wp-includes/post-template.php

Retrieves an array of the class names for the body element.

wp_xmlrpc_server::mw_getPost()wp-includes/class-wp-xmlrpc-server.php

Retrieves a post.

wp_xmlrpc_server::mw_getRecentPosts()wp-includes/class-wp-xmlrpc-server.php

Retrieves list of recent posts.

wp_xmlrpc_server::_prepare_post()wp-includes/class-wp-xmlrpc-server.php

Prepares post data for return in an XML-RPC object.

_WP_Editors::editor_settings()wp-includes/class-wp-editor.php
Show 5 moreShow less

Changelog

VersionDescription
3.1.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    Usage in Templates

    /*
 * Pull in a different sub-template, depending on the Post Format.
 * 
 * Make sure that there is a default format.php file to fall back to as a default.
 * Name templates format-link.php, format-aside.php, etc.
 *
 * You should use this in the loop.
 */
get_template_part( 'format', get_post_format() );

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