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

Retrieve the format slug for a post

Contents

Description Description

Parameters Parameters

$post

(int|object|null) (Optional) Post ID or post object. Optional, default is the current post from the loop.

Default value: null

Top ↑

Return Return

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

Top ↑

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

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/category-template.php: get_the_terms()

Retrieve 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.

Top ↑

Used By Used By

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()
Show 5 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

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

    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() );
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example

    /*
 * 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.