• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

ファイルヘッダー

提供: WordPress Codex 日本語版
File Headerから転送)
移動先: 案内検索

WordPressに於いて、テーマプラグインは一つ以上の(Drop-Ins, Must-Use-Plugins:を持つことがある)、所謂ファイルヘッダーを持ち、メタ情報(名前、ヴァージョン、作者、等)を含む。

ファイルヘッダーはファイルの先頭ブロック(必ずしも一番先頭である必要はないが)にあり、一つのヘッダが一行である。ヘッダはNameValueからなる。

ファイルヘッダーの例

以下の、ファイルヘッダー例はテーマとプラグインの例から引用されたもので、WordPressと一緒に提供されるまたはWordPressプロジェクトに極めて近く関連しているものである(初期テーマおよびコアとなるプラグインである):

プラグインファイルヘッダーの例

プラグインのヘルスチェックを行うために、health-check.phpファイルの一番最初の行に以下が記載されている:

<?php
/*
	Plugin Name: Health Check
	Plugin URI: http://wordpress.org/extend/plugins/health-check/
	Description: Checks the health of your WordPress install
	Author: The Health Check Team
	Version: 0.1-alpha
	Author URI: http://wordpress.org/extend/plugins/health-check/
	Text Domain: health-check
	Domain Path: /lang
 */

class HealthCheck {
[...]

テーマファイルヘッダーの例

Twentytenテーマの一部である、style.cssファイルの一番最初のラインには以下が記載せれている:

/*
Theme Name: Twenty Ten
Theme URI: http://wordpress.org/
Description: The 2010 theme for WordPress is stylish, customizable, simple, and readable -- make it yours with a custom menu, header image, and background. Twenty Ten supports six widgetized areas (two in the sidebar, four in the footer) and featured images (thumbnails for gallery posts and custom header images for posts and pages). It includes stylesheets for print and the admin Visual Editor, special styles for posts in the "Asides" and "Gallery" categories, and has an optional one-column page template that removes the sidebar.
Author: the WordPress team
Version: 1.2
License: GNU General Public License
License URI: license.txt
Tags: black, blue, white, two-columns, fixed-width, custom-header, custom-background, threaded-comments, sticky-post, translation-ready, microformats, rtl-language-support, editor-style, custom-menu
*/

ヘッダー名のリスト

以下が、2010年6月2日現在のテーマとプラグインにデフォルトで実装されいているファイルヘッダーのヘッダー名リストである。ヘッダーは拡張可能なためこれはサブセットであり、上位セットではない:

プラグイン

  • Author (プラグイン)
  • Author URI (プラグイン)
  • Description (プラグイン)
  • Domain Path (プラグイン)
  • Network (プラグイン)
  • Plugin Name (プラグイン)
  • Plugin URI (プラグイン)
  • Site Wide Only (プラグイン; Networkによって廃止された)
  • Text Domain (プラグイン)
  • Version (プラグイン)

テーマ

  • Author (テーマ)
  • Author URI (テーマ)
  • Description (テーマ)
  • Status (テーマ)
  • Tags (テーマ)
  • Template (テーマ)
  • Theme Name (テーマ)
  • Theme URI (テーマ)
  • Version (テーマ)

ページテンプレート

いくつかのプラグインヘッダーの説明については、プラグインファイルヘッダーを、テーマヘッダーについてはテーマスタイルシートを、それぞれ参照してください。

一つまたは複数の確固とした要件を見つけられなかった場合、WordPressのソースコードを読むことで、より詳しい情報を得る必要があるでしょう(下記のFile Header関連機能記載の関数やフックのリストを参照してください)。

ヘッダーファイル名

プラグイン/テーマの複数のファイルはメタ情報を含む場合があるため、以下のファイル名と順番(上から下へ)はヘッダー向けに構文解析されたものである。

Plugin

  1. ディレクトリの順番に沿った各PHPファイル。もしファイルがNameヘッダーを持たない場合、それはプラグインとして扱われない。

Theme

  1. style.cssという名のCSSファイル。

Must-Use Plugin

  1. 実際のPHPファイル

Drop-In

  1. 実際のPHPファイル

ヘッダー仕様

デファクトの実装として、ファイルヘッダーは以下を満たす必要がある:

  1. ヘッダーはPHPまたはCSSファイルの先頭ブロックに書かれていること。
  2. ブロックはPHPやCSSコメントのように、ファイルコメントに置かれることがある。
  3. ヘッダーブロック全体は、ファイル全体の最初8129バイト以内に置かれる必要がある。
  4. ヘッダーは各行に一つづつ、互いにフォローアップされる。
  5. ヘッダーはNameとValueから構成される
  6. NameとValueは':'にて分けられる。
  7. Nameは最低でも1つ、多くとも3つの単語を持つ。
  8. 単語の最小長さは3文字、最長は12文字である。
  9. 単語はa-zとA-Zの文字から成る。
  10. 単語は一つのスペース(d32/x20)にて分けられる。
  11. Nameは行の先頭か、ホワイトスペースキャラクターの後から始まる。
  12. Nameは':'キャラクターの前に終わる。
  13. Valueは':'キャラクターの後から始まる。
  14. ':'キャラクターの後にスペースが付く場合があるが、それはValueの一部とはみなされない。
  15. ヘッダーのValueはどのような文字でも良いが、新規ラインに行ってはならない。
  16. ヘッダーのValueは使用される前にフィルターを掛けられることがある。
  17. ヘッダーのValueは、XHTMLエレメントやHTMLタグの形でのHTMLコードを含むことができるが、必須ではない。

Note: これらは独立したヘッダーであるという性格上、最大の単語数および単語あたりの最小と最大文字数はデフォルトヘッダーを素にしている。これはヘッダー名のサブセットであるため、使用するプラグインの実装具合によって異なることがある。

ファイルヘッダー関連情報

File Header APIはテーマとプラグインのファイルヘッダーおよび関連するフック(actions, filters)から成る。

ヘッダーの内容

いくつかのAPI機能はヘッダーにコンテキストの追加を可能とする。WordPressのコアコードでは、2つのコンテキストが定義されている。テーマ ('theme') と プラグイン ('plugin')である。

readme.txt内のファイルヘッダー

いくつかのプラグインは、ヘッダーにそっくりな情報を含むことのあるreadme.txtファイルを含む。これらのファイルはWordPressでは処理されないが、サードパーティ製アプリケーションで処理される。なぜなら、それらのアプリケーションが極めて人気があるためである。例として取り上げたreadmeファイルから、それらのタグを紹介する:

Contributors: markjaquith, mdawaffe (this should be a list of wordpress.org userid's)
Donate link: http://example.com/
Tags: comments, spam
Requires at least: 2.0.2
Tested up to: 2.1
Stable tag: 4.3

ticket #12260が提案するように、readme.txtからのヘッダーは、リモートのWP.org APIから呼び出される。これはサードパーティアプリケーションがWordPressコアコードの使用に直接の影響を与えるという、よい例である

最新英語版: WordPress Codex » WordPress APIs最新版との差分