Template:MediaWikiHook

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:MediaWikiHook and the translation is 83% complete.

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎română • ‎čeština • ‎македонски • ‎русский • ‎नेपाली • ‎中文 • ‎日本語
解説のアイコン テンプレートの解説

コピー & ペースト テンプレート

MyHook
version ??? から利用可能

関数の定義:
public static function onMyHook( $x, $y ) { ... }
フックのアタッチ:

extension.json 内:

{
	"Hooks": {
		"MyHook": "MyExtensionHooks::onMyHook"
	}
}

MediaWiki 1.25 以前では:

$wgHooks['MyHook'][] = 'MyExtensionHooks::onMyHook';
呼び出し元:ファイル:

フックの付け方の詳細はManual:フックの情報を参照してください。
このフックを使用する拡張機能の例については、Category:MyHook extensions/ja を参照してください。

{{MediaWikiHook
|name = MyHook
|version =
|gerrit =
|removed =
|summary =
|args = $x, $y
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
}}

使用法の注記

A card which describes the information of a MediaWiki-registered hook.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Template modetemplatemode

Set to nocats if hook documentation should not appear in standard MediaWiki Categories. By default, using this template places the documentation page into categories: MediaWiki hooks Hooks added in MediaWiki... There are times when it is undesirable to automatically categorize the hook documentation. Examples would include when documenting a hook in an extension, or when documenting the template itself.

Unknownoptional
Namename

The name of the hook. This is usually the same name as the sub-page.

Unknownoptional
Versionversion

The version of MediaWiki this hook was first introduced in.

Unknownsuggested
Version removedremoved

If the hook has been removed, the version of MediaWiki that it was removed in.

Stringoptional
New variable namenewvarname

no description

Unknownoptional
New variable linknewvarlink

no description

Unknownoptional
Version deprecateddeprecated

If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.

Unknownoptional
SVN revision introducedrev

SVN revision in which this hook was first introduced. If this parameter is given, it'll link to the appropriate CodeReview page (e.g. [[Special:Code/MediaWiki/1]]).

Unknownoptional
Gerrit changesetgerrit

Gerrit change number in which this hook was first introduced. If this parameter is given, it'll link to the appropriate Gerrit changeset page (e.g. Gerrit change 1)

Unknownsuggested
Summarysummary

A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content.

Unknownrequired
Argumentsargs

The arguments, as used at the top of the function.

Unknownrequired
Extensionextension

no description

Unknownoptional
File sourcesource

Location (file name/path not including <code>includes/</code>) which calls this hook in the code. Further locations can be added via source2...source10.

Unknownsuggested
File source 2source2

no description

Unknownoptional
File source 3source3

no description

Unknownoptional
File source 4source4

no description

Unknownoptional
File source 5source5

no description

Unknownoptional
File source 6source6

no description

Unknownoptional
File source 7source7

no description

Unknownoptional
File source 8source8

no description

Unknownoptional
File source 9source9

no description

Unknownoptional
File source 10source10

no description

Unknownoptional
Function sourcesourcefunction

Name of the function which calls this hook. Another can be added via sourcefunction2.

Unknownsuggested
Function source 2sourcefunction2

no description

Unknownoptional
Class sourcesourceclass

Name of the class which calls this hook.

Unknownsuggested
name
フックの名前。 通常、これは下位ページと同じ名前です。
version
このフックが最初に導入された MediaWiki バージョン。
rev
このフックが最初に導入された SVN リビジョン。 この属性を追加すると、対応するコードリビューのページ(Special:Code/MediaWiki/1他)に自動的にリンクします。
gerrit
このフックが最初に導入された Gerrit change 番号。 この属性を追加すると、自動的に対応するGerrit changesetのページ(Gerrit change 1)にリンクします。
removed
フックが除去された場合、除去された際の MediaWiki バージョン。
deprecated
フックが廃止予定になった (ただし除去はされていない) 場合、廃止予定になった際の MediaWiki バージョン。
summary
フックの使用目的の短い説明。
説明は詳しい方が望ましいので、メインページで内容を補完してください。
短い説明のページを編集したら、必ずManual:フック を開きテーブル2件の更新をお願いします。
args
関数に伴って提示する引数。
source
コード内でこのフックを参照する位置(ファイル名)。位置の追加はsource2...source10と指定する。
sourcefunction
このフックを参照する関数名。追加にはsourcefunctionを使う。
sourceclass
このフックを参照するクラス名。
templatemode
標準のMediaWikiカテゴリでフックの説明文章を非表示にするには、nocatsを選択。
既定では、このテンプレートを使用すると、説明文書ページは以下のカテゴリに分類されます:
  • MediaWiki フック
  • MediaWiki に追加されたフック...
ただし説明文書を自動的に既定のカテゴリに振り分けない方がよい場合があります。 その一例とは、拡張機能に含まれるフックや、テンプレート自体の説明文書の場合です。

Finding a hook's version and Gerrit ID

To populate the version and gerrit attributes of this template, you may need to search the history of the docs/hooks.txt file.

  1. (From the top-level of a Git clone of MediaWiki source code)
  2. Find the oldest commit to hooks.txt that mentions the hook:
    • git grep <フック名> $(git rev-list --all -- docs/hooks.txt) -- docs/hooks.txt | tail -n 1
  3. Find its Gerrit ID:
    • git log <上記で取得したコミット>
    1. Copy the change-id from the log entry into the Gerrit search box
    2. Select the relevant change, and get its ID
  4. Find out what release the hook was first included in:
    • git tag --contains <上記で取得したコミット>