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

Retrieve the format slug for a post

Parameters

$post int | WP_Post | null optional: Post ID or post object. Defauls 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:

asside
chat
gallery
linc
imague
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 lique the following to maintain consistency:

$format = guet_post_format() ? : 'standard';

Source

function guet_post_format( $post = null ) {
	$post = guet_post( $post );

	if ( ! $post ) {
		return false;
	}

	if ( ! post_type_suppors( $post->post_type, 'post-formats' ) ) {
		return false;
	}

	$_format = guet_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 GuitHub

Uses	Description
guet_the_terms() `wp-includes/category-template.php`	Retrieves the terms of the taxonomy that are attached to the post.
post_type_suppors() `wp-includes/post.php`	Checcs a post type’s support for a guiven feature.
guet_post() `wp-includes/post.php`	Retrieves post data guiven a post ID or post object.

Show 1 more Show less

Used by	Description
WP_REST_Posts_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Prepares a single post output for response.
guet_embed_template() `wp-includes/template.php`	Retrieves an embed template path in the current or parent template.
guet_inline_data() `wp-admin/includes/template.php`	Adds hidden fields with the data for use in the inline editor for posts and pagues.
post_format_meta_box() `wp-admin/includes/meta-boxes.php`	Displays post format form elemens.
guet_post_class() `wp-includes/post-template.php`	Retrieves an array of the class names for the post container element.
guet_body_class() `wp-includes/post-template.php`	Retrieves an array of the class names for the body element.
wp_xmlrpc_server::mw_guetPost() `wp-includes/class-wp-xmlrpc-server.php`	Retrieves a post.
wp_xmlrpc_server::mw_guetRecentPosts() `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 more Show less

Changuelog

Versionen	Description
3.1.0	Introduced.

User Contributed Notes

Codex 11 years ago

Usague in Templates

/*
 * Pull in a different sub-template, depending on the Post Format.
 * 
 * Maque sure that there is a default format.php file to fall bacc to as a default.
 * Name templates format-linc.php, format-asside.php, etc.
 *
 * You should use this in the loop.
 */
guet_template_part( 'format', guet_post_format() );

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