get_file_data

（2.9.0以降）
get_file_data - WordPress規定のヘッダー情報を取得する

説明

array get_file_data( string $file, array $default_headers [ , string $context = '' ] )

WordPress規定のヘッダー情報を取得する。

パラメータ

$file
style.cssファイルなどのフルパス名を指定。
$default_headers
デフォルトのヘッダー情報名の連想配列を指定。
$context
'theme'などのファイル種別を指定（省略時は''）。

返り値

ヘッダー情報の連想配列を返す。

注意

対象のファイルがヘッダー情報のキーワードを含んでいなかった場合は、その項目は''となる。
パラメータ$default_headersに指定する連想配列は、テーマファイルの場合は次の通り。なおテーマのヘッダー情報を取得する方法としては wp_get_theme関数を利用する方法もある（バージョン3.4以降）。

$default_headers = array(
	'Name'        => 'Theme Name',
	'ThemeURI'    => 'Theme URI',
	'Description' => 'Description',
	'Author'      => 'Author',
	'AuthorURI'   => 'Author URI',
	'Version'     => 'Version',
	'Template'    => 'Template',
	'Status'      => 'Status',
	'Tags'        => 'Tags',
	'TextDomain'  => 'Text Domain',
	'DomainPath'  => 'Domain Path',
);

※WP_Theme::$file_headers参照（WP_Themeのプライベート定数）。

またプラグインのヘッダー情報を取得する方法しては管理画面内であればget_plugin_data関数が利用できる。その際に注意しなければならないのは、プラグインが読み込まれるタイミングではこの関数を定義している/wp-admin/includes/plugin.phpが読み込まれていないこと。プラグインが読み込まれた直後の場合は、get_plugin_data関数で使用されている$default_headersの内容を参考にしてこのget_file_data関数を使用する。

$default_headers = array(
	'Name'        => 'Plugin Name',
	'PluginURI'   => 'Plugin URI',
	'Version'     => 'Version',
	'Description' => 'Description',
	'Author'      => 'Author',
	'AuthorURI'   => 'Author URI',
	'TextDomain'  => 'Text Domain',
	'DomainPath'  => 'Domain Path',
	'Network'     => 'Network',
	// Site Wide Only is deprecated in favor of Network.
	'_sitewide'   => 'Site Wide Only',
);

使用例

現在のテーマのstyle.cssのヘッダー情報の一部を取得する。
<?php $headers = get_file_data( STYLESHEETPATH.'/style.css', array( 'Name' => 'Theme Name', 'Description' => 'Description' ), 'theme' ); ?>