当前浏览:首页 / WordPress函数 / get_post_format()

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

检索文章格式的slug

format 格式

postmore...


参数

$post

(int|WP_Post|null) (可选) 文章 ID或Post对象,默认为循环中的当前文章。

默认值: null


返回

(string|false) 成功时返回格式,否则为false。


说明

这通常在循环中调用,但如果提供了文章 ID,则可以在任何地方使用。

当前定义的格式包括:

  • aside
  • chat
  • gallery
  • link
  • image
  • quote
  • status
  • video
  • audio

还要注意的是,默认格式(即正常文章)返回false,但在某些地方也被称为“标准”(standard)格式。在某些情况下,开发人员可能希望执行以下操作以保持一致性:

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


源码

查看源码 官方文档


更新日志

版本描述
3.1.0开始引入

用户贡献的笔记

  • 贡献者:Codex

    模板中的用法

    /*
     * 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() );