Manual:Hooks/pt-br



Os ganchos permitem que o código personalizado seja executado quando ocorre um evento definido (como salvar uma página ou um usuário efetuando login). Por exemplo, o seguinte fragmento de código irá ativar uma chamada para a função  sempre que   giros de gancho, passando-o a função de argumentos específicos para :

""

O MediaWiki fornece muitos ganchos como este para estender a funcionalidade do software MediaWiki. Atribuir uma função (conhecida como manipulador de eventos) para um gancho, essa função será chamada no ponto apropriado do código MediaWiki principal, para executar qualquer tarefa adicional que o desenvolvedor pense ser útil nesse ponto. Cada gancho pode ter vários manipuladores atribuídos a ele, caso em que ele chamará as funções na ordem em que são atribuídas, com quaisquer modificações feitas por uma função passada para funções subseqüentes na cadeia.

Atribua funções para encaixar no fim de ou no seu próprio arquivo de extensão no escopo do arquivo (não na função  ou no  hook). Para extensões, se o comportamento da função de gancho estiver condicionado a uma configuração em LocalSettings.php, o gancho deve ser atribuído e a função deve terminar cedo se a condição não for atendida.

Você também pode criar novos ganchos em sua própria extensão; se você fizer isso, adicione-os ao Registro de gancho de extensão.

Contexto
A hook is triggered by a call to the function Hooks::run (described in file, and defined in GlobalFunctions.php. The first argument to Hooks::run is the name of the hook, the second is the array of arguments for that hook. It will find the event handlers to run in the array $wgHooks. It calls the PHP function call_user_func_array with arguments being the function to be called and its arguments.

See also the.

In this example from the  function in WikiPage.php, doEditContent calls Hooks::run to run the PageContentSaveComplete hook, passing   as argument:

""

The core calls many hooks, but extensions can also call hooks.

Writing an event handler
An event handler is a function you assign to a hook, which will be run whenever the event represented by that hook occurs. It consists of:


 * uma função com alguns dados de acompanhamento opcionais, ou
 * um objeto com um método e alguns dados acompanhantes opcionais.

Register the event handler by adding it to the global  array for a given event. Hooks can be added from any point in the execution before the hook is called, but are most commonly added in LocalSettings.php, its included files, or, for extensions, in the file extension.json. All the following are valid ways to define a hook function for the event EventName that is passed two parameters, showing the code that will be executed when EventName happens:

For extensions, the syntax is similar in the file  (corresponding to the first and second case above):

When an event occurs, the function (or object method) that you registered will be called the event's parameters along with any optional data you provided at registration. Note that when an object is the hook and you didn't specify a method, the method called is 'onEventName'. For other events this would be 'onArticleSave', 'onUserLogin', etc.

The optional data is useful if you want to use the same function or object for different purposes. For example:

This code would result in ircNotify being run twice when a page is saved: once for 'TimStarling', and once for 'brion'.

Event handlers can return one of three possible values:


 * no return value (or null): the hook handler has operated successfully. (Before MediaWiki 1.23, returning true was required.)
 * "some string": an error occurred; processing should stop and the error should be shown to the user
 * false: the hook handler has done all the work necessary, or replaced normal handling. This will prevent further handlers from being run, and in some cases tells the calling function to skip normal processing.

The last result would be for cases where the hook function replaces the main functionality. For example, if you wanted to authenticate users to a custom system (LDAP, another PHP program, whatever), you could do:

Returning false makes less sense for events where the action is complete, and will normally be ignored by the caller.

Documentation
Currently, hooks in MediaWiki core have to be documented both in (in the source code repository) and here on MediaWiki.org. In some cases, one of these steps may not yet have been completed, so if a hook appears undocumented, check both.

To document a hook on-wiki, use MediaWikiHook.

Available hooks
This page contains a list of hooks that are made available by the MediaWiki software, and is known to be complete to version 1.8.2. There is a lot of detail missing for the more recent hooks in particular, as their purpose/usage has not yet been documented by the developers. If you have any further information on any of these then please add it in the appropriate place.

In the tables, the first column gives the MediaWiki version that the hook was introduced in; use the link in the second column to find out more information about the hook and how to use it.

Hooks grouped by function
Some of these hooks can be grouped into multiple functions.
 * Sections: Article Management - Edit Page - Page Rendering - User Interface - Special Pages - User Management - Logging - Skinning Templates - API - Import/Export - Miscellaneous

Hooks grouped by version
To see hooks grouped by version go to the table above and click the arrow symbol in the version table header.