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以降)。

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

フィルター

パラメータ$contextが指定されている場合、それに応じたフィルターを実行し、拡張ヘッダー情報名を取得する。
$extra_headers = apply_filters( "extra_{$context}_headers", array() )

アクション

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

ソースファイル

/wp-includes/functions.php

最終更新 : 2017年09月07日 15:34



お勧め

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。