云策 WordPress 开发者社区

函数文档

get_post_mime_types()

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

概述

get_post_mime_types() 函数用于获取默认的文章 MIME 类型数组，主要用于媒体库分类。该函数返回一个包含 MIME 类型组及其标签的数组，并支持通过 'post_mime_types' 过滤器进行自定义。

关键要点

  • 函数返回一个数组，键为 MIME 类型组（如 'image', 'audio'）或 MIME 类型字符串，值为包含标签的数组。
  • 标签数组包括组名、管理名称和复数翻译字符串（使用 _n_noop）。
  • 函数内部处理非核心组（如 'document', 'spreadsheet', 'archive'），通过 wp_get_ext_types() 和 wp_get_mime_types() 映射扩展名到 MIME 类型。
  • 提供 'post_mime_types' 过滤器（apply_filters）允许开发者修改默认列表。
  • 自 WordPress 5.3.0 起，新增了 'Documents'、'Spreadsheets' 和 'Archives' 组。

代码示例

// 示例：获取并打印默认 MIME 类型数组
$mime_types = get_post_mime_types();
print_r($mime_types);

注意事项

  • 函数在 WordPress 2.9.0 中引入，后续版本有更新，如 5.3.0 添加了新组。
  • 相关函数包括 wp_get_ext_types()、wp_get_mime_types()、_n_noop()、__()、_x() 和 apply_filters()。
  • 主要用于后台媒体管理，如 wp_edit_attachments_query_vars() 和 wp_enqueue_media()。
📄 原文内容

Gets default post mime types.

Return

array List of post mime types.

Source

function get_post_mime_types() {
	$post_mime_types = array(   // array( adj, noun )
		'image'       => array(
			__( 'Images' ),
			__( 'Manage Images' ),
			/* translators: %s: Number of images. */
			_n_noop(
				'Image <span class="count">(%s)</span>',
				'Images <span class="count">(%s)</span>'
			),
		),
		'audio'       => array(
			_x( 'Audio', 'file type group' ),
			__( 'Manage Audio' ),
			/* translators: %s: Number of audio files. */
			_n_noop(
				'Audio <span class="count">(%s)</span>',
				'Audio <span class="count">(%s)</span>'
			),
		),
		'video'       => array(
			_x( 'Video', 'file type group' ),
			__( 'Manage Video' ),
			/* translators: %s: Number of video files. */
			_n_noop(
				'Video <span class="count">(%s)</span>',
				'Video <span class="count">(%s)</span>'
			),
		),
		'document'    => array(
			__( 'Documents' ),
			__( 'Manage Documents' ),
			/* translators: %s: Number of documents. */
			_n_noop(
				'Document <span class="count">(%s)</span>',
				'Documents <span class="count">(%s)</span>'
			),
		),
		'spreadsheet' => array(
			__( 'Spreadsheets' ),
			__( 'Manage Spreadsheets' ),
			/* translators: %s: Number of spreadsheets. */
			_n_noop(
				'Spreadsheet <span class="count">(%s)</span>',
				'Spreadsheets <span class="count">(%s)</span>'
			),
		),
		'archive'     => array(
			_x( 'Archives', 'file type group' ),
			__( 'Manage Archives' ),
			/* translators: %s: Number of archives. */
			_n_noop(
				'Archive <span class="count">(%s)</span>',
				'Archives <span class="count">(%s)</span>'
			),
		),
	);

	$ext_types  = wp_get_ext_types();
	$mime_types = wp_get_mime_types();

	foreach ( $post_mime_types as $group => $labels ) {
		if ( in_array( $group, array( 'image', 'audio', 'video' ), true ) ) {
			continue;
		}

		if ( ! isset( $ext_types[ $group ] ) ) {
			unset( $post_mime_types[ $group ] );
			continue;
		}

		$group_mime_types = array();
		foreach ( $ext_types[ $group ] as $extension ) {
			foreach ( $mime_types as $exts => $mime ) {
				if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {
					$group_mime_types[] = $mime;
					break;
				}
			}
		}
		$group_mime_types = implode( ',', array_unique( $group_mime_types ) );

		$post_mime_types[ $group_mime_types ] = $labels;
		unset( $post_mime_types[ $group ] );
	}

	/**
	 * Filters the default list of post mime types.
	 *
	 * @since 2.5.0
	 *
	 * @param array $post_mime_types Default list of post mime types.
	 */
	return apply_filters( 'post_mime_types', $post_mime_types );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘post_mime_types’, array $post_mime_types )

Filters the default list of post mime types.

Uses Description
wp_get_ext_types()wp-includes/functions.php

Retrieves the list of common file extensions and their types.
_n_noop()wp-includes/l10n.php

Registers plural strings in POT file, but does not translate them.
wp_get_mime_types()wp-includes/functions.php

Retrieves the list of mime types and file extensions.
__()wp-includes/l10n.php

Retrieves the translation of $text.
_x()wp-includes/l10n.php

Retrieves translated string with gettext context.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 3 moreShow less

Used by Description
wp_edit_attachments_query_vars()wp-admin/includes/post.php

Returns the query variables for the current attachments request.
get_media_item()wp-admin/includes/media.php

Retrieves HTML form for modifying the image attachment.
wp_edit_attachments_query()wp-admin/includes/post.php

Executes a query for attachments. An array of WP_Query arguments can be passed in, which will override the arguments set by this function.
wp_enqueue_media()wp-includes/media.php

Enqueues all scripts, styles, settings, and templates necessary to use all media JS APIs.

Changelog

Version Description
5.3.0 Added the 'Documents', 'Spreadsheets', and 'Archives' mime type groups.
2.9.0 Introduced.