WordPress.org

Languages: English • 한국어 • Español • 日本語 中文(简体) • (Add your language)

Description

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

Usage

<?php $format = get_post_format( $post_id ); ?>

Parameters

$post_id

(integer or object) (Optional) ID of the post or the post object.

Default: current loop post

Returns

Format (string) 

The format of the post, or false if no format is set.

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';

Example

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

$format = get_post_format();
get_template_part( 'format', $format );
?>

Changelog

• Since: 3.1

Source File

get_post_format() is located in wp-includes/post-formats.php.

External Resources

• Post types and formats and taxonomies, oh my! by Otto
• WordPress 3.1 Post Formats Reference by Lisa Sabin-Wilson
• Smarter Post Formats? by Dougal Campbell
• Smarter Post Formats? Use Carrington by Alex King

Related

Post Formats: set_post_format(), get_post_format(), has_post_format(), get_post_format_link(), get_post_format_string(), the_post_format_audio(), get_the_post_format_media(), get_content_audio(), the_post_format_chat(), get_the_post_format_chat(), get_content_chat(), add_chat_detection_format(), the_post_format_gallery(), get_content_galleries(), get_post_gallery_images(), the_post_format_image(), get_the_post_format_image(), get_content_images(), the_post_format_quote(), get_the_post_format_quote(), get_content_quote(), the_post_format_url(), get_the_post_format_url(), get_content_url(), the_post_format_video(), get_content_video(), the_remaining_content(), get_the_remaining_content(), get_post_format_meta(), post_format_content_class(), get_post_format_content_class(), post_formats_compat()