get_file_data

説明

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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。