当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「ファイルヘッダー」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(途中まで訳しました)
(改名しました)
 
(2人の利用者による、間の9版が非表示)
1行目: 1行目:
 +
 
__TOC__
 
__TOC__
WordPressに於いて、[[テーマ]]と[[プラグイン]]は一つ以上の(''Drop-Ins'', ''Must-Use-Plugins'':を持つことがある)、所謂'''File Headers'''を持ち、メタ情報(名前、ヴァージョン、作者、等)を含む。
+
WordPressに於いて、[[テーマ]]と[[プラグイン]]は一つ以上の(''Drop-Ins'', ''Must-Use-Plugins'':を持つことがある)、所謂'''ファイルヘッダー'''を持ち、メタ情報(名前、ヴァージョン、作者、等)を含む。
  
''File Headers''はファイルの先頭ブロック(必ずしも一番先頭である必要はないが)にあり、一つのヘッダが一行である。ヘッダは''Name''と''Value''からなる。
+
''ファイルヘッダー''はファイルの先頭ブロック(必ずしも一番先頭である必要はないが)にあり、一つのヘッダが一行である。ヘッダは''Name''と''Value''からなる。
  
== File Headerの例 ==
+
== ファイルヘッダーの例 ==
以下の、''file header examples''はテーマとプラグインの例から引用されたもので、WordPressと一緒に提供されるまたはWordPressプロジェクトに極めて近く関連しているものである(初期テーマおよびコアとなるプラグインである):
+
以下の、''ファイルヘッダー例''はテーマとプラグインの例から引用されたもので、WordPressと一緒に提供されるまたはWordPressプロジェクトに極めて近く関連しているものである(初期テーマおよびコアとなるプラグインである):
  
=== プラグインFile Headerの例 ===
+
=== プラグインファイルヘッダーの例 ===
 
プラグインのヘルスチェックを行うために、<code>health-check.php</code>ファイルの一番最初の行に以下が記載されている:
 
プラグインのヘルスチェックを行うために、<code>health-check.php</code>ファイルの一番最初の行に以下が記載されている:
  
25行目: 26行目:
 
  [...]
 
  [...]
  
=== テーマFile Headerの例 ===
+
=== テーマファイルヘッダーの例 ===
 
Twentytenテーマの一部である、<code>style.css</code>ファイルの一番最初のラインには以下が記載せれている:
 
Twentytenテーマの一部である、<code>style.css</code>ファイルの一番最初のラインには以下が記載せれている:
 
<pre>
 
<pre>
42行目: 43行目:
 
== ヘッダー名のリスト ==
 
== ヘッダー名のリスト ==
  
以下が、2010年6月2日現在のテーマとプラグインにデフォルトで実装されいているFile Headerのヘッダー名リストである。ヘッダーは拡張可能なためこれはサブセットであり、上位セットではない:
+
以下が、2010年6月2日現在のテーマとプラグインにデフォルトで実装されいているファイルヘッダーのヘッダー名リストである。ヘッダーは拡張可能なためこれはサブセットであり、上位セットではない:
  
 
=== プラグイン ===
 
=== プラグイン ===
  
* ''Author'' (Plugin)
+
* ''Author'' (プラグイン)
* ''Author URI'' (Plugin)
+
* ''Author URI'' (プラグイン)
* ''Description'' (Plugin)
+
* ''Description'' (プラグイン)
* ''Domain Path'' (Plugin)
+
* ''Domain Path'' (プラグイン)
* ''Network'' (Plugin)
+
* ''Network'' (プラグイン)
* ''Plugin Name'' (Plugin)
+
* ''Plugin Name'' (プラグイン)
* ''Plugin URI'' (Plugin)
+
* ''Plugin URI'' (プラグイン)
* ''Site Wide Only'' (Plugin; deprecated in favor of ''Network'')
+
* ''Site Wide Only'' (プラグイン; ''Network''によって廃止された)
* ''Text Domain'' (Plugin)
+
* ''Text Domain'' (プラグイン)
* ''Version'' (Plugin)
+
* ''Version'' (プラグイン)
  
 
=== テーマ ===
 
=== テーマ ===
  
* ''Author'' (Theme)
+
* ''Author'' (テーマ)
* ''Author URI'' (Theme)
+
* ''Author URI'' (テーマ)
* ''Description'' (Theme)
+
* ''Description'' (テーマ)
* ''Status'' (Theme)
+
* ''Status'' (テーマ)
* ''Tags'' (Theme)
+
* ''Tags'' (テーマ)
* ''Template'' (Theme)
+
* ''Template'' (テーマ)
* ''Theme Name'' (Theme)
+
* ''Theme Name'' (テーマ)
* ''Theme URI'' (Theme)
+
* ''Theme URI'' (テーマ)
* ''Version'' (Theme)
+
* ''Version'' (テーマ)
  
 
=== [[Pages#Creating_Your_Own_Page_Templates|ページテンプレート]] ===
 
=== [[Pages#Creating_Your_Own_Page_Templates|ページテンプレート]] ===
74行目: 75行目:
 
* 説明 (cf. [http://core.svn.wordpress.org/trunk/wp-content/themes/twentyeleven/showcase.php twentyeleven])
 
* 説明 (cf. [http://core.svn.wordpress.org/trunk/wp-content/themes/twentyeleven/showcase.php twentyeleven])
  
いくつかのプラグインヘッダーの説明については、[[Writing_a_Plugin#File_Headers|プラグイン File Headers]]を、テーマヘッダーについては[[Theme_Development#Theme_Stylesheet|テーマスタイルシート]]を、それぞれ参照してください。
+
いくつかのプラグインヘッダーの説明については、[[Writing_a_Plugin#標準プラグイン情報|プラグインファイルヘッダー]]を、テーマヘッダーについては[[Theme_Development#テーマスタイルシート|テーマスタイルシート]]を、それぞれ参照してください。
  
If you are unable to find a concrete specification for the one or other header, you need to read the WordPress source-code to find out more specific information about them (please see ''File Header Related Functions'' below for a list of related functions and hooks).
+
一つまたは複数の確固とした要件を見つけられなかった場合、WordPressのソースコードを読むことで、より詳しい情報を得る必要があるでしょう(下記の''File Header関連機能''記載の関数やフックのリストを参照してください)
  
== File Header Filenames ==
+
== ヘッダーファイル名 ==
Since multiple files in a plugin/theme can contain meta information, the following are the file-names and the order (from top to bottom) of which files are parsed for headers.
+
プラグイン/テーマの複数のファイルはメタ情報を含む場合があるため、以下のファイル名と順番(上から下へ)はヘッダー向けに構文解析されたものである。
  
 
=== Plugin ===
 
=== Plugin ===
# Each PHP-file in the directory order. If a file does not contain the ''Name'' header, it won't be treated as a plugin.
+
# ディレクトリの順番に沿った各PHPファイル。もしファイルが''Name''ヘッダーを持たない場合、それはプラグインとして扱われない。
  
 
=== Theme ===
 
=== Theme ===
# The <code>style.css</code> CSS-file
+
# <code>style.css</code>という名のCSSファイル。
  
 
=== Must-Use Plugin ===
 
=== Must-Use Plugin ===
# The concrete PHP-file
+
# 実際のPHPファイル
  
 
=== Drop-In ===
 
=== Drop-In ===
# The concrete PHP-file
+
# 実際のPHPファイル
  
== File Header Specification ==
+
== ヘッダー仕様 ==
Per de-facto implementation, ''File Headers'' can be specified as the following:
+
デファクトの実装として、''ファイルヘッダー''は以下を満たす必要がある:
  
# Header are written in a block in the beginning of a PHP or CSS file.
+
# ヘッダーはPHPまたはCSSファイルの先頭ブロックに書かれていること。
# A block might be placed in a files comment, like a PHP or CSS comment.
+
# ブロックはPHPやCSSコメントのように、ファイルコメントに置かれることがある。
# The whole header block must be placed inside the first 8 192 bytes of the file.
+
# ヘッダーブロック全体は、ファイル全体の最初8129バイト以内に置かれる必要がある。
# Headers follow up to each other, one on it's own line.
+
# ヘッダーは各行に一つづつ、互いにフォローアップされる。
# A header consists of a name and a value.
+
# ヘッダーはNameとValueから構成される
# Name and value are separated by the ':' character.
+
# NameとValueは':'にて分けられる。
# The name has a minimum of one, and a maximum of three words.
+
# Nameは最低でも1つ、多くとも3つの単語を持つ。
# The minimum length of a word is three, the maximum length is 12 characters.
+
# 単語の最小長さは3文字、最長は12文字である。
# A word consists of the characters a-z and A-Z.
+
# 単語はa-zとA-Zの文字から成る。
# Words are separated by a single space (d32/x20)
+
# 単語は一つのスペース(d32/x20)にて分けられる。
# A name starts after the beginning of a line or after a whitespace character.
+
# Nameは行の先頭か、ホワイトスペースキャラクターの後から始まる。
# A name ends before the ':' character.
+
# Nameは':'キャラクターの前に終わる。
# A value starts after the ':' character.
+
# Valueは':'キャラクターの後から始まる。
# Sometimes the ':' character is suffixed by a space. This space is considered to not be part of the value.
+
# ':'キャラクターの後にスペースが付く場合があるが、それはValueの一部とはみなされない。
# A header-value can contain any characters but not a newline.
+
# ヘッダーのValueはどのような文字でも良いが、新規ラインに行ってはならない。
# Header values might become filtered before they are used.
+
# ヘッダーのValueは使用される前にフィルターを掛けられることがある。
# Header values can but must not contain HTML code in form of certain XHTML Elements or HTML Tags.
+
# ヘッダーのValueは、XHTMLエレメントやHTMLタグの形でのHTMLコードを含むことができるが、必須ではない。
  
'''Note:''' Because of the nature that there are individual headers, the maximum number of words as well as the minimum and maximum number of characters per word are based on default headers. Because this is a subset and not the superset of all header names, this might vary depending on the implementation and plugins you are using.
+
'''Note:''' これらは独立したヘッダーであるという性格上、最大の単語数および単語あたりの最小と最大文字数はデフォルトヘッダーを素にしている。これはヘッダー名のサブセットであるため、使用するプラグインの実装具合によって異なることがある。
  
== File Header Related Functions ==
+
== ファイルヘッダー関連情報 ==
  
The '''File Header API''' consists of all functions regarding theme and plugin file headers and related hooks (actions, filters).
+
'''File Header API'''はテーマとプラグインのファイルヘッダーおよび関連するフック(actions, filters)から成る。
  
* [[Function_Reference/get_file_data|get_file_data()]]
+
* [[関数リファレンス/get_file_data|get_file_data()]] /[[:en:Function_Reference/get_file_data|en]]
* [[Function_Reference/wp_get_theme|wp_get_theme()]]
+
* [[関数リファレンス/wp_get_theme|wp_get_theme()]] /[[:en:Function_Reference/wp_get_theme|en]]
* [[Function_Reference/get_plugin_data|get_plugin_data()]]
+
* [[関数リファレンス/get_plugin_data|get_plugin_data()]] /[[:en:Function_Reference/get_plugin_data|en]]
* [[Function_Reference/_get_plugin_data_markup_translate|_get_plugin_data_markup_translate()]]
+
* [[関数リファレンス/_get_plugin_data_markup_translate|_get_plugin_data_markup_translate()]] /[[:en:Function_Reference/_get_plugin_data_markup_translate|en]]
* [[Function_Reference/_cleanup_header_comment|_cleanup_header_comment()]]
+
* [[関数リファレンス/_cleanup_header_comment|_cleanup_header_comment()]] /[[:en:Function_Reference/_cleanup_header_comment|en]]  
* Filter:  <code>extra_*_headers</code> (e.g.: <code>extra_theme_headers</code>, <code>extra_plugin_headers</code>)
+
* フィルター:  <code>extra_*_headers</code> (e.g.: <code>extra_theme_headers</code>, <code>extra_plugin_headers</code>)
  
=== Header Context ===
+
=== ヘッダーの内容 ===
Some of the API functions provide the possibility to add a context to headers. There are two contexts defined in the wordpress core code: Themes (<code>'theme'</code>) and Plugins (<code>'plugin'</code>).
+
いくつかのAPI機能はヘッダーにコンテキストの追加を可能とする。WordPressのコアコードでは、2つのコンテキストが定義されている。テーマ (<code>'theme'</code>) と プラグイン (<code>'plugin'</code>)である。
  
== File Headers in readme.txt ==
+
== readme.txt内のファイルヘッダー ==
Some plugins contain the readme.txt file which might contain look-a-like headers as well. Those files are not handled by WordPress but by third-party applications. Because those applications can be quite popular, I note down here those tags from an example readme file:
+
いくつかのプラグインは、ヘッダーにそっくりな情報を含むことのあるreadme.txtファイルを含む。これらのファイルはWordPressでは処理されないが、サードパーティ製アプリケーションで処理される。なぜなら、それらのアプリケーションが極めて人気があるためである。例として取り上げたreadmeファイルから、それらのタグを紹介する:
  
 
  Contributors: markjaquith, mdawaffe (this should be a list of wordpress.org userid's)
 
  Contributors: markjaquith, mdawaffe (this should be a list of wordpress.org userid's)
140行目: 141行目:
 
  Stable tag: 4.3
 
  Stable tag: 4.3
  
As [http://core.trac.wordpress.org/ticket/12260 ticket #12260] suggests, the headers from readme.txt are used through remote WP.org API calls. This is a good example of how third party applications use has direct impact on wordpress core code usage.
+
[http://core.trac.wordpress.org/ticket/12260 ticket #12260]が提案するように、readme.txtからのヘッダーは、リモートのWP.org APIから呼び出される。これはサードパーティアプリケーションがWordPressコアコードの使用に直接の影響を与えるという、よい例である
 +
 
 +
{{原文|WordPress APIs|126767}} <!--23:10, 6 February 2013‎ Amereservant -->
  
[[Category:Design and Layout]]
+
[[Category:デザインとレイアウト]]
[[Category:Plugins]]
+
[[Category:プラグイン]]
[[Category:WordPress Development]]
+
[[Category:WordPress_の開発]]
 +
[[Category:API]]
 
[[Category:File Header API]]
 
[[Category:File Header API]]

2015年5月25日 (月) 11:19時点における最新版

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最新版との差分