Predefinição: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 100% complete.
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎română • ‎čeština • ‎македонски • ‎русский • ‎नेपाली • ‎中文 • ‎日本語
Documentação da predefinição

Predefinição para copiar e colar

MyHook
Disponível a partir da version ???

Função de definição:
public static function onMyHook( $x, $y ) { ... }
Anexar hook:

Na extension.json:

{
	"Hooks": {
		"MyHook": "MyExtensionHooks::onMyHook"
	}
}
Chamado a partir de:Arquivo(s):
Interface:MyHookHook.php

Para mais informações sobre anexar hooks, consulte Manual:Ganchos .
Para exemplos de extensões que usam este hook, consulte Category:MyHook extensions/pt-br.

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

Notas de uso

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
Message for removed hookremoved-msg

If it is not suitable to use either the "newvarname" or the "newvarlink" template parameter, use this parameter. This parameter can be used to explain why it was removed, or for example, explain why there is no suitable replacement.

Stringoptional
Version deprecateddeprecated

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

Unknownoptional
Message for deprecated hookdeprecated-msg

If it is not suitable to use either the "newvarname" or the "newvarlink" template parameter, use this parameter. This parameter can be used to explain why it was removed, or for example, explain why there is no suitable replacement.

Stringoptional
New variable namenewvarname

For removed or deprecated hooks, the name of the hook that should be used instead

Unknownoptional
New variable linknewvarlink

For removed or deprecated hooks, the link to the hook that should be used instead

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. [[phabricator:rSVN1]]).

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
Nome do hook. Geralmente o mesmo que o da sub-página.
version
Versão do MediaWiki na qual o hook foi lançado.
rev
Revisão do SVN na qual o hook foi lançado. Se esse parâmetro for fornecido, ele criará uma ligação à página do CodeReview (p. ex., phabricator:rSVN1).
gerrit
Número da mudança no Gerrit no qual o hook foi lançado. Se esse parâmetro for fornecido, ele criará uma ligação à página de changeset no Gerrit (p. ex., Mudança 1 do Gerrit)
removed
Se o hook foi removido, especificar a versão do MediaWiki na qual isso aconteceu.
deprecated
Se o hook foi depreciado (mas não removido), a versão do MediaWiki na qual isso aconteceu.
summary
Descrição rápida do propósito do hook.
Claro que descrições mais detalhadas são úteis, mas devem ser adicionadas à página principal do hook.
Se a descrição rápida for atualizada, atualize também as duas tabelas em Manual:Ganchos .
args
Argumentos da função.
source
Locação (nome do arquivo) que chama o hook no código. Outras locações podem ser adicionadas de source2 a source10.
sourcefunction
Nome das funções pelas quais o hook é chamado.
sourceclass
Nome da classe pela qual o hook é chamado.
templatemode
Defina como nocats caso a documentação do hook não deva aparecer nas categorias padrões do MediaWiki.
Por padrão, a transclusão dessa predefinição adiciona a página de documentação às categorias:
  • MediaWiki hooks (/pt-br)
  • Hooks added in MediaWiki… (/pt-br)
Algumas vezes, deseja-se não categorizar automaticamente a documentação do hook. Exemplos para isso podem ser ao documentar um hook numa extensão ou ao documentar a própria predefinição.

Encontrando a versão do hook e o ID do Gerrit

Para popular os atributos version e gerrit da predefinição, será necessário encontrar o histórico do arquivo docs/hooks.txt.

  1. (A partir do nível-topo (principal) de um clone do Git do código-fonte do MediaWiki)
  2. Encontre o commit mais antigo ao hooks.txt que mencione o hook:
    • git grep <nome-do-hook-aqui> $(git rev-list --all -- docs/hooks.txt) -- docs/hooks.txt | tail -n 1
  3. Encontre o ID do Gerrit:
    • git log <o-commit-da-etapa-anterior>
    1. Copie o change-id do registro na caixa de pesquisa do Gerrit
    2. Selecione a mudança relevante, e nela estará o ID
  4. Encontre a release na qual o hook foi lançado:
    • git tag --contains <aquele-mesmo-commit>