云策 WordPress 开发者社区

函数文档

get_post_format_strings()

查看官方原文 ↗
💡 云策文档标注

概述

get_post_format_strings() 函数返回一个数组，将文章格式的 slugs 映射到其翻译后的美观显示版本。该函数主要用于获取 WordPress 中所有文章格式的本地化标签。

关键要点

  • 函数返回一个关联数组，键为文章格式的 slug（如 'standard'、'aside'），值为对应的翻译后显示字符串。
  • 数组包含 WordPress 默认支持的文章格式，如标准、旁白、聊天、画廊、链接、图像、引用、状态、视频和音频。
  • 此函数在 WordPress 3.1.0 版本中引入，常用于主题或插件开发中需要显示文章格式名称的场景。

代码示例

function get_post_format_strings() {
    $strings = array(
        'standard' => _x( 'Standard', 'Post format' ),
        'aside'    => _x( 'Aside', 'Post format' ),
        'chat'     => _x( 'Chat', 'Post format' ),
        'gallery'  => _x( 'Gallery', 'Post format' ),
        'link'     => _x( 'Link', 'Post format' ),
        'image'    => _x( 'Image', 'Post format' ),
        'quote'    => _x( 'Quote', 'Post format' ),
        'status'   => _x( 'Status', 'Post format' ),
        'video'    => _x( 'Video', 'Post format' ),
        'audio'    => _x( 'Audio', 'Post format' ),
    );
    return $strings;
}
📄 原文内容

Returns an array of post format slugs to their translated and pretty display versions

Return

string[] Array of post format labels keyed by format slug.

Source

function get_post_format_strings() {
	$strings = array(
		'standard' => _x( 'Standard', 'Post format' ), // Special case. Any value that evals to false will be considered standard.
		'aside'    => _x( 'Aside', 'Post format' ),
		'chat'     => _x( 'Chat', 'Post format' ),
		'gallery'  => _x( 'Gallery', 'Post format' ),
		'link'     => _x( 'Link', 'Post format' ),
		'image'    => _x( 'Image', 'Post format' ),
		'quote'    => _x( 'Quote', 'Post format' ),
		'status'   => _x( 'Status', 'Post format' ),
		'video'    => _x( 'Video', 'Post format' ),
		'audio'    => _x( 'Audio', 'Post format' ),
	);
	return $strings;
}

View all references View on Trac View on GitHub

Uses Description
_x()wp-includes/l10n.php

Retrieves translated string with gettext context.
Used by Description
get_default_block_template_types()wp-includes/block-template-utils.php

Returns a filtered list of default template types, containing their localized titles and descriptions.
WP_REST_Post_Format_Search_Handler::search_items()wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php

Searches the post formats for a given search request.
get_post_format_slugs()wp-includes/post-formats.php

Retrieves the array of post format slugs.
get_post_format_string()wp-includes/post-formats.php

Returns a pretty, translated version of a post format slug
wp_xmlrpc_server::mw_editPost()wp-includes/class-wp-xmlrpc-server.php

Edits a post.
wp_xmlrpc_server::mw_newPost()wp-includes/class-wp-xmlrpc-server.php

Creates a new post.
wp_xmlrpc_server::wp_getPostFormats()wp-includes/class-wp-xmlrpc-server.php

Retrieves a list of post formats used by the site.

Show 2 moreShow less

Changelog

Version Description
3.1.0 Introduced.