Template:ExtensionHook/ja

{{Documentation|content=

使用法の注記

 * name
 * フックの名前. これは通常、下位ページと同じ名前です.


 * version
 * このフックが最初に導入された MediaWiki バージョン.


 * rev
 * このフックが最初に導入された SVN リビジョン. このパラメーターが指定されている場合、適切な CodeReview ページ (例: r115794) にリンクされます.


 * gerrit
 * このフックが最初に導入された Gerrit change 番号. このパラメーターを指定すると、適切な Gerrit 変更セット ページにリンクされます (例: Gerrit 変更 5)


 * removed
 * フックが除去された場合は、それが除去された際の MediaWiki のバージョン.


 * deprecated
 * フックが廃止予定になった (ただし除去はされていない) 場合、廃止予定になった際の MediaWiki バージョン.


 * summary
 * フックの使用目的の短い説明.
 * より詳細な説明が望ましいため、メイン ページの本文に追加する必要があります.
 * 短い説明を更新する場合は、 の 2 つの表も更新してください.


 * args
 * 関数の上部で使用される引数.


 * extension
 * Extension name where hook is called; for when the source is not in the Mediawiki core code repository.


 * source
 * コード内でこのフックを呼び出す場所 (ファイル名). さらに場所を source2...source10 で追加できます.


 * sourcefunction
 * このフックを呼び出す関数の名前. sourcefunction2 でもう 1 つ追加できます.


 * sourceclass
 * このフックを呼び出すクラスの名前.


 * newvarname
 * removed または deprecated が設定されている場合、Removed または Deprecated によって使用されます.


 * newvarlink
 * removed または deprecated が設定されている場合、Removed または Deprecated によって使用されます.


 * templatemode
 * フックの説明文書を標準の MediaWiki カテゴリに表示しない場合は、nocats に設定します.
 * 既定では、このテンプレートを使用すると、説明文書ページがカテゴリに追加されます:
 * MediaWiki フック
 * MediaWiki に追加されたフック...
 * フックの説明文書を自動的にカテゴリ化 (カテゴリに追加) することが望ましくない場合があります. その例には、拡張機能のフックを文書化する場合、テンプレート自体を文書化する場合が含まれます.

Template data
{	"params": { "templatemode": { "label": "Template mode", "type": "string" },		"name": { "label": "Name", "description": "The name of the hook. This is usually the same name as the sub-page.", "type": "string", "required": true },		"removed": { "label": "Version removed", "description": "If the hook has been removed, the version of MediaWiki that it was removed in.", "type": "string" },		"newvarname": { "label": "Replacement name", "description": "If the hook is either deprecated or removed, name the feature that replaces this hook, if there is any replacement.", "type": "string" },		"newvarlink": { "label": "Replacement link", "description": "If the hook is either deprecated or removed, link to the feature that replaces this hook, if there is any replacement.", "type": "wiki-page-name" },		"deprecated": { "label": "Version deprecated", "description": "If the hook has been deprecated, the version of MediaWiki that it was deprecated in.", "type": "string" },		"version": { "label": "Version introduced", "description": "The version of MediaWiki this hook was first introduced in.", "type": "string", "suggested": true },		"rev": { "label": "SVN revision introduced", "description": "SVN revision in which this hook was first introduced. If this parameter is given, it will link to the appropriate CodeReview page.", "type": "string" },		"gerrit": { "label": "Gerrit changeset introduced", "description": "Gerrit change number in which this hook was first introduced. If this parameter is given, it will link to the appropriate Gerrit changeset page.", "type": "number", "suggested": true },		"summary": { "label": "Summary", "description": "A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content.", "type": "string", "suggested": true },		"args": { "label": "Arguments", "description": "The arguments that are defined by the hook signature.", "required": true, "type": "string" },		"extension": { "label": "Extension name", "description": "Extension name where the hook is called; for when the source is not in the Mediawiki core code repository.", "type": "wiki-page-name", "required": true },		"source": { "label": "Source 1", "description": "Location (file name) which calls this hook in the code.", "type": "string", "suggested": true },		"source2": { "label": "Source 2", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source3": { "label": "Source 3", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source4": { "label": "Source 4", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source5": { "label": "Source 5", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source6": { "label": "Source 6", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source7": { "label": "Source 7", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source8": { "label": "Source 8", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source9": { "label": "Source 9", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source10": { "label": "Source 10", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"sourcefunction": { "label": "Source function", "description": "Name of the function which calls this hook", "type": "string", "suggested": true },		"sourceclass": { "label": "Source class", "description": "The fully qualified class name (FQCN) which calls this hook.", "suggested": true, "type": "string" },		"sourcefunction2": { "label": "Source function 2", "description": "Name of the function which calls this hook, if another functions call this hook", "type": "string" }	},	"description": "A card which describes the information of a hook registered by an extension.", "paramOrder": [ "templatemode", "name", "rev", "gerrit", "version", "deprecated", "removed", "newvarname", "newvarlink", "summary", "args", "extension", "source", "source2", "source3", "source4", "source5", "source6", "source7", "source8", "source9", "source10", "sourceclass", "sourcefunction", "sourcefunction2" ],	"format": "block" }

関連項目


}}