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

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.

Uses · 3

• get_post()Retrieves post data given a post ID or post object.
• post_type_supports()Checks a post type's support for a given feature.
• get_the_terms()Retrieves the terms of the taxonomy that are attached to the post.

Used by · 16

• Twenty_Eleven_Ephemera_Widget::widget()Outputs the HTML for this widget.
• WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
• _WP_Editors::editor_settings()
• get_body_class()Retrieves an array of the class names for the body element.
• get_embed_template()Retrieves an embed template path in the current or parent template.
• get_inline_data()Adds hidden fields with the data for use in the inline editor for posts and pages.
• get_post_class()Retrieves an array of the class names for the post container element.
• post_format_meta_box()Displays post format form elements.
• twenty_twenty_one_entry_meta_footer()Prints HTML with meta information for the categories, tags and comments.
• twentyfifteen_entry_meta()Prints HTML with meta information for the categories, tags.
• twentysixteen_entry_meta()Prints HTML with meta information for the categories, tags.
• twentythirteen_entry_date()Print HTML with date information for current post.

Source

View on Trac ↗View on GitHub ↗

17function get_post_format( $post = null ) {18	$post = get_post( $post );19 20	if ( ! $post ) {21		return false;22	}23 24	if ( ! post_type_supports( $post->post_type, 'post-formats' ) ) {25		return false;26	}27 28	$_format = get_the_terms( $post->ID, 'post_format' );29 30	if ( empty( $_format ) ) {31		return false;32	}33 34	$format = reset( $_format );35 36	return str_replace( 'post-format-', '', $format->slug );37}

History

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/post-formats.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.