获取标准WordPress主题文件和其他各种标准WordPress文件的说明

原型

get_file_description( string $file )

参数

$file (string) (Required) 文件系统路径或文件名

返回值

(string)  如果描述不存在,则来自$ wp_file_descriptions或$ file的基本名称的文件描述。如果文件是页面模板,则将“页面模板”附加到$ file的基本名称

源文件

路径:wp-admin/includes/file.php

<?php
...
function get_file_description( $file ) {
	global $wp_file_descriptions, $allowed_files;
	$dirname = pathinfo( $file, PATHINFO_DIRNAME );
	$file_path = $allowed_files[ $file ];
	if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $dirname ) {
		return $wp_file_descriptions[ basename( $file ) ];
	} elseif ( file_exists( $file_path ) && is_file( $file_path ) ) {
		$template_data = implode( '', file( $file_path ) );
		if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ) ) {
			return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );
		}
	}
	return trim( basename( $file ) );
}
...
?>

其他

英文文档:https://developer.wordpress.org/reference/functions/get_file_description/