get_file_description

函数
get_file_description ( $file )
参数
  • (string) $file Filesystem path or filename.
    Required:
返回值
  • (string) Description of file from $wp_file_descriptions or basename of $file if description doesn't exist. Appends 'Page Template' to basename of $file if the file is a page template.
定义位置
相关方法
term_descriptionget_the_archive_descriptionget_the_author_descriptionthe_archive_descriptiontag_description
引入
1.5.0
弃用
-

get_file_description: WordPress函数,用于检索一个指定文件的描述: 该函数以文件路径为参数,如果文件存在,则返回文件描述。如果该文件没有描述,该函数返回一个空字符串。

获取标准WordPress主题文件的描述。

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 ) ) {
			/* translators: %s: Template name. */
			return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );
		}
	}

	return trim( basename( $file ) );
}

常见问题

FAQs
查看更多 >