get_post_format()

You are here:

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

Retrieve the format slug for a post

Parameters Parameters

$post

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

Default value: null


Top ↑

Return Return

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


Top ↑

More Information 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:

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

 

 


Top ↑

Source Source

File: wp-includes/post-formats.php

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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 );
}


Top ↑

Changelog Changelog

Changelog
VersionDescription
3.1.0Introduced.
Was this article helpful?
Dislike 0
Views: 2

Cart

Log in

Create an Account
Back to Top