get_post_format() - WordPress 函数参考中文文档

返回介绍

get_post_format()

发布于 2017-09-10 字数3826 浏览 853 评论 0

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

Retrieve the format slug for a post


描述


参数

$post

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

Default value: null


返回值

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


源代码

File: wp-includes/post-formats.php

function get_post_format( $post = null ) {
	if ( ! $post = get_post( $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 );
}

更新日志

Version 描述
3.1.0 Introduced.

相关函数

Uses

  • wp-includes/category-template.php:
    get_the_terms()
  • wp-includes/post.php:
    post_type_supports()
  • wp-includes/post.php:
    get_post()

Used By

  • wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php:
    WP_REST_Posts_Controller::prepare_item_for_response()
  • wp-includes/template.php:
    get_embed_template()
  • wp-admin/includes/class-wp-posts-list-table.php:
    WP_Posts_List_Table::column_title()
  • wp-admin/includes/class-wp-press-this.php:
    WP_Press_This::html()
  • wp-admin/includes/class-wp-press-this.php:
    WP_Press_This::post_formats_html()
  • wp-admin/includes/template.php:
    get_inline_data()
  • wp-admin/includes/meta-boxes.php:
    post_format_meta_box()
  • wp-includes/post-template.php:
    get_post_class()
  • wp-includes/post-template.php:
    get_body_class()
  • wp-includes/class-wp-xmlrpc-server.php:
    wp_xmlrpc_server::mw_getPost()
  • wp-includes/class-wp-xmlrpc-server.php:
    wp_xmlrpc_server::mw_getRecentPosts()
  • wp-includes/class-wp-xmlrpc-server.php:
    wp_xmlrpc_server::_prepare_post()
  • wp-includes/class-wp-editor.php:
    _WP_Editors::editor_settings()
  • Show 8 more used by
    Hide more used by


User Contributed Notes

  1. Skip to note 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. 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() );
    

上一篇:get_post_field()

下一篇:get_post_format_link()

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!