ワードプレスのwp_get_l10n_php_file_data関数の使用方法・解説

概要

wp_get_l10n_php_file_data関数は、PHP翻訳ファイルからヘッダー情報を抽出するために使用されます。この関数は主に以下のような機能を実装する際に利用されます。

1. プラグインやテーマの翻訳ファイルに含まれるメタデータを取得する。
2. 多言語対応のために翻訳情報を管理する。
3. テーマやプラグインのレイアウトやスタイルを言語別に変更する。
4. 管理画面での視覚的な言語切替えをサポートする。
5. さまざまな文化圏に合わせた文言の表示を可能にする。
6. プラグインの設定ページでの翻訳文の情報表示。
7. ユーザーインターフェースの一部で異なる言語を表示する。
8. 自動翻訳ファイルの更新時に変更点を把握する。

構文

wp_get_l10n_php_file_data( $file, $default_headers, $plugins );

パラメータ

• $file (string): チェックする翻訳ファイルのパス。
• $default_headers (array): 抽出したいメタデータのヘッダー名を定義した配列。
• $plugins (mixed): プラグインかどうかを確認するフラグ（通常はtrueまたはfalse）。

戻り値

• (array): 指定されたヘッダーの情報を含む連想配列。

関連する関数

• get_file_data
• load_textdomain

使用可能なバージョン

この関数はWordPressのバージョン4.7以降で使用可能です。特定のバージョンで非推奨または削除されている情報はありません。

コアファイルのパス

wp-includes/l10n.php

この関数のアクションでの使用可能性

アクション	使用例
mu_plugin_loaded	〇
registered_post_type
plugins_loaded	〇
wp_roles_init
setup_theme	〇
after_setup_theme	〇
set_current_user
init	〇
register_sidebar
wp_loaded	〇
send_headers
parse_query
pre_get_posts
wp	〇
template_redirect
get_header
wp_head	〇

サンプルコード

サンプル1: メタデータを取得

このコードは指定された翻訳ファイルからメタデータを取得します。

$file = 'path/to/your/l10n-file.php';
$default_headers = array(
    'Name' => 'Plugin Name',
    'Version' => 'Version',
);

$data = wp_get_l10n_php_file_data( $file, $default_headers );

echo $data['Name']; // プラグイン名を出力

出典: WordPress Codex

サンプル2: 翻訳ファイルの存在チェック

このコードは翻訳ファイルが存在するか確認し、メタデータを取得します。

$file = 'path/to/your/l10n-file.php';

if ( file_exists( $file ) ) {
    $data = wp_get_l10n_php_file_data( $file, array() );
    var_dump($data); // メタデータをデバッグ表示
}

出典: WordPress Codex

サンプル3: デフォルトヘッダーの設定

異なるデフォルトヘッダーを設定してメタデータを取得するサンプルです。

$file = 'path/to/your/l10n-file.php';
$default_headers = array(
    'Description' => 'Description',
    'Author' => 'Author',
);

$data = wp_get_l10n_php_file_data( $file, $default_headers );

echo $data['Description']; // 説明を出力

出典: WordPress Codex

サンプル4: プラグイン情報の管理

プラグインの翻訳ファイルから情報を取得し、管理画面で表示する例です。

function display_plugin_info() {
    $file = 'path/to/plugin/l10n-file.php';
    $info = wp_get_l10n_php_file_data( $file, array( 'Name', 'Version' ) );

    echo '<h2>' . esc_html( $info['Name'] ) . '</h2>';
    echo '<p>' . esc_html( $info['Version'] ) . '</p>';
}

add_action( 'admin_notices', 'display_plugin_info' );

出典: WordPress Codex

サンプル5: フロントエンドでの使用

フロントエンドでプラグイン名を表示する例です。

function show_plugin_name() {
    $file = 'path/to/plugin/l10n-file.php';
    $data = wp_get_l10n_php_file_data( $file, array( 'Name' => 'Plugin Name' ) );

    echo '<p>プラグイン名: ' . esc_html( $data['Name'] ) . '</p>';
}
add_action( 'wp_footer', 'show_plugin_name' );

出典: WordPress Codex