函数文档

wp_get_l10n_php_file_data()

💡 云策文档标注

概述

wp_get_l10n_php_file_data() 函数用于从 PHP 翻译文件中提取头部信息。它接受一个 .l10n.php 文件路径作为参数,返回一个以头部名称为键的数组。

关键要点

  • 函数参数:$php_file(字符串,必需),指向 .l10n.php 文件的路径。
  • 返回值:数组,包含 POT-Creation-Date、PO-Revision-Date、Project-Id-Version 和 X-Generator 等头部值。
  • 函数内部通过 include 加载文件数据,移除 messages 部分,并映射 PHP 头部到 PO 头部格式。
  • 此函数在 WordPress 6.6.0 版本中引入。

代码示例

function wp_get_l10n_php_file_data( $php_file ) {
    $data = (array) include $php_file;

    unset( $data['messages'] );
    $headers = array(
        'POT-Creation-Date'  => 'pot-creation-date',
        'PO-Revision-Date'   => 'po-revision-date',
        'Project-Id-Version' => 'project-id-version',
        'X-Generator'        => 'x-generator',
    );

    $result = array(
        'POT-Creation-Date'  => '',
        'PO-Revision-Date'   => '',
        'Project-Id-Version' => '',
        'X-Generator'        => '',
    );

    foreach ( $headers as $po_header => $php_header ) {
        if ( isset( $data[ $php_header ] ) ) {
            $result[ $po_header ] = $data[ $php_header ];
        }
    }

    return $result;
}

📄 原文内容

Extracts headers from a PHP translation file.

Parameters

$php_filestringrequired
Path to a .l10n.php file.

Return

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

Source

function wp_get_l10n_php_file_data( $php_file ) {
	$data = (array) include $php_file;

	unset( $data['messages'] );
	$headers = array(
		'POT-Creation-Date'  => 'pot-creation-date',
		'PO-Revision-Date'   => 'po-revision-date',
		'Project-Id-Version' => 'project-id-version',
		'X-Generator'        => 'x-generator',
	);

	$result = array(
		'POT-Creation-Date'  => '',
		'PO-Revision-Date'   => '',
		'Project-Id-Version' => '',
		'X-Generator'        => '',
	);

	foreach ( $headers as $po_header => $php_header ) {
		if ( isset( $data[ $php_header ] ) ) {
			$result[ $po_header ] = $data[ $php_header ];
		}
	}

	return $result;
}

Changelog

Version Description
6.6.0 Introduced.