函数文档

wp_get_pomo_file_data()

💡 云策文档标注

概述

wp_get_pomo_file_data() 函数用于从 PO 文件中提取头部信息,返回以头部名称为键的数组。它基于 get_file_data() 函数实现,并处理特定格式的清理。

关键要点

  • 函数 wp_get_pomo_file_data() 提取 PO 文件的头部数据,如 POT-Creation-Date、PO-Revision-Date 等。
  • 参数 $po_file 是必需的,指定 PO 文件的路径。
  • 返回值为字符串数组,键为头部名称,值为对应的头部值。
  • 内部使用 get_file_data() 函数读取文件,并通过正则表达式清理值中的转义字符和引号。
  • 该函数自 WordPress 3.7.0 版本引入,主要用于 wp_get_installed_translations() 等函数。

代码示例

function wp_get_pomo_file_data( $po_file ) {
    $headers = get_file_data(
        $po_file,
        array(
            'POT-Creation-Date'  => '"POT-Creation-Date',
            'PO-Revision-Date'   => '"PO-Revision-Date',
            'Project-Id-Version' => '"Project-Id-Version',
            'X-Generator'        => '"X-Generator',
        )
    );
    foreach ( $headers as $header => $value ) {
        // Remove possible contextual 'n' and closing double quote.
        $headers[ $header ] = preg_replace( '~(\n)?"$~', '', $value );
    }
    return $headers;
}

📄 原文内容

Extracts headers from a PO file.

Parameters

$po_filestringrequired
Path to PO file.

Return

string[] Array of PO file header values keyed by header name.

Source

function wp_get_pomo_file_data( $po_file ) {
	$headers = get_file_data(
		$po_file,
		array(
			'POT-Creation-Date'  => '"POT-Creation-Date',
			'PO-Revision-Date'   => '"PO-Revision-Date',
			'Project-Id-Version' => '"Project-Id-Version',
			'X-Generator'        => '"X-Generator',
		)
	);
	foreach ( $headers as $header => $value ) {
		// Remove possible contextual 'n' and closing double quote.
		$headers[ $header ] = preg_replace( '~(\n)?"$~', '', $value );
	}
	return $headers;
}

Changelog

Version Description
3.7.0 Introduced.