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

フィルター

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

アクション

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

ソースファイル

/wp-includes/functions.php

関連

お勧めコンテンツ

標準で使用できる数少ないショートコード[caption]とは(2011年5月7日 登録)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 登録)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。

常時SSL接続に変更しました(2017年3月3日 登録)

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

投稿ページでユニークなテンプレートを選択しよう(2016年12月19日 登録)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 登録)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

最終更新日時 : 2017-09-07 15:34