概要
get_file_data関数は、主にWordPressプラグインやテーマのヘッダー情報を取得するために使用されます。この関数は、特定のファイル内のメタデータを簡単に取得するための便利な手段を提供します。よく使われる機能には以下があります。
- プラグインのバージョン取得
- テーマの名前や作者情報の取得
- 必要なPHPバージョンの取得
- ライセンス情報の取得
- テーマやプラグインの更新情報取得
- カスタムフィールドの取得
- ブロックエディタ用のメタデータ取得
- 子テーマや親テーマに関する情報取得
構文
get_file_data( $file, $fields, $scheme );
パラメータ
$file: 対象のファイルのパス（必須）。$fields: 取得したいヘッダー情報の配列（必須）。$scheme: 取得するデータのフォーマットを指定するオプション（省略可能）。
戻り値
指定したヘッダー情報の配列を返します。指定されたキーが存在しない場合は、空の値が返されます。
関連する関数
使用可能なバージョン
get_file_data関数は、バージョン 2.7.0 以降のWordPressで使用可能です。
コアファイルのパス
get_file_data関数は、WordPressのコアファイル wp-includes/functions.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 | 〇 |
サンプルコード
以下に、get_file_data関数を使用したサンプルコードを示します。
-
プラグインのバージョンを取得
$plugin_data = get_file_data( 'path/to/plugin/file.php', array( 'Version' => 'Version', 'Description' => 'Description' ) ); echo 'Plugin Version: ' . $plugin_data['Version'];- このコードは、指定されたプラグインファイルからバージョンと説明を取得して表示します。
-
テーマの情報を取得
$theme_data = get_file_data( 'path/to/theme/style.css', array( 'Name' => 'Theme Name', 'URI' => 'Theme URI' ) ); echo 'Theme Name: ' . $theme_data['Name'];- テーマのスタイルシートからテーマ名とURIを取得して表示します。
-
カスタムフィールドを取得
$custom_data = get_file_data( 'path/to/custom-file.php', array( 'CustomField' => 'FieldKeyword' ) ); echo 'Custom Field: ' . $custom_data['CustomField'];- カスタムファイルから特定のカスタムフィールドを取得します。
-
ライセンス情報を取得
$license_info = get_file_data( 'path/to/plugin/file.php', array( 'License' => 'License' ) ); echo 'License: ' . $license_info['License'];- プラグインファイルからライセンス情報を取得して表示します。
-
PHPの最小バージョンを取得
$php_version = get_file_data( 'path/to/plugin/file.php', array( 'RequiresPHP' => 'RequiresPHP' ) ); echo 'Requires PHP: ' . $php_version['RequiresPHP'];- プラグインファイル内のPHPの最小バージョンを取得します。
各サンプルコードは著作権フリーのものです。引用元となるURLは特にありませんが、これらの基本的な使い方はWordPressの公式ドキュメントやコミュニティ内でよく見られるものです。