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以降、青字は5.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',
	'RequiresWP'  => 'Requires at least',
	'RequiresPHP' => 'Requires PHP',
);

※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' ); ?>

フィルター

パラメータ$contextが指定されている場合、それに応じたフィルターを実行し、拡張ヘッダー情報名を取得する。

$extra_headers = apply_filters( "extra_{$context}_headers", array() )

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/functions.php

最終更新 : 2020年04月06日 14:42

参考

Code Reference: get_file_data

お勧め

フィードにサムネイル画像を追加する（2022年11月7日更新）

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた（2019年11月5日更新）

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

スマートフォン向けの振り分けを自前で行う（2012年1月23日更新）

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5の機能強化：コメントフォームのちょっとした改良（2020年8月12日更新）

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3（以降Beta 3）」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧め