Manual:Hooks/de



Hooks (dt. Haken) ermöglichen die Ausführung von benutzerdefiniertem Code, wenn ein definiertes Ereignis (wie das Speichern einer Seite oder die Anmeldung eines Benutzers) eintritt. Beispielsweile löst der folgende Codeausschnitt einen Aufruf der Funktion aus, wenn der  -Hook ausgeführt wird, wobei ihm Funktionsargumente übergeben werden, die spezifisch für  sind.

Hooks können registriert werden, indem der Name des Hooks dem Callback in der -Datei der Erweiterung zugeordnet wird:

MediaWiki bietet viele solcher Hooks, um die Funktionalität der MediaWiki-Software zu erweitern. Die Zuweisung einer Funktion (bekannt als Ereignisbehandler) zu einem Hook bewirkt, dass diese Funktion an der entsprechenden Stelle im MediaWiki-Hauptcode aufgerufen wird, um die zusätzliche(n) Aufgabe(n) auszuführen, die der Entwickler an dieser Stelle für nützlich hält. Jedem Hook können mehrere Handler zugewiesen werden. In diesem Fall ruft er die Funktionen in der Reihenfolge auf, in der sie zugewiesen sind, wobei alle Änderungen, die von einer Funktion vorgenommen werden, an nachfolgende Funktionen in der Kette weitergegeben werden.

Assign functions to hooks at the end of or in your own extension file at the file scope (not in a  function or the  hook). For extensions, if the hook function's behavior is conditioned on a setting in LocalSettings.php, the hook should be assigned and the function should terminate early if the condition was not met.

You can also create new hooks in your own extension. It is registered in extension.json the same way as if you were registering a built-in MediaWiki hook to use in your extension. You can then run your hook within your extension by calling. Lastly, don't forget to add them to.

Hintergrund
A hook is triggered by a call to HookContainer::run, usually via a method in HookRunner. HookContainer will find the hook handlers to run and call them with the parameters given to HookContainer::run. Hook handlers are registered via.

Siehe auch.

In this example from the  function in, doPurge calls HookRunner::onArticlePurge to run the  hook, passing   as argument:

Der ruft viele Hooks auf, aber  können auch Hooks aufrufen.



Schreiben eines Ereignishandler
Ein Event-Handler ist eine Funktion, die zu einem Hook zugeordnet ist, der ausgeführt wird, wenn das Ereignis von diesem Hook vertreten auftritt wird. Es besteht aus:

For extensions, register your hook handlers in :

Eventhandler werden registriert, indem sie sie zum globalen Array für ein gegebenes Ereignis hinzufügen. Hooks können von jedem beliebigen Punkt in der Ausführung hinzugefügt werden, bevor der Hook aufgerufen ist, sind aber am häufigsten in hinzugefügt oder seiner enthaltenen Dateien. Alle die folgenden sind gültige Möglichkeiten, um Hooks zu definieren, mit dem Code der ausgeführt wird, wenn EventName passiert:

Beachten Sie, dass wenn ein Objekt der Hook ist und es keine festgelegte Methode gibt, die Standard-Methode namens 'OnEventName' ist. Für verschiedene Ereignisse wäre dies anders: 'onArticleSave', 'onUserLogin', etc.

Die zusätzlichen Daten sind sinnvoll, wenn wir die gleiche Funktion oder ein Objekt für unterschiedliche Zwecke nutzen wollen. Zum Beispiel:

Dieser Code würde in das zweimalige Laufen resultieren, wenn ein Artikel gespeichert wird: einmal für 'TimStarling', und einmal für "Brion".

Hook handler return values
Event-Handler können einen von drei möglichen Werten zurückgeben:


 * (no return value, or null) - the hook handler has operated successfully. (Vor MediaWiki 1.23 war ein Ergebniswert von true benötigt.)
 * "some string": ein Fehler ist aufgetreten; die Verarbeitung sollte abbrechen, und der Fehler sollte dem Benutzer angezeigt werden
 * - 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.

Returning false makes less sense for hooks that run after an action is already completed. In those cases, the return value is often ignored.

Handling hooks in MediaWiki 1.35 and later
MediaWiki 1.35 introduces the HookHandlers system. This includes per-hook interfaces for improved static validation and discovery of parameter documentation. It also enables dependency injection by introducing an intermediary class instance that accepts a number of specified services (instead of static callbacks that explicitly access services from global state).

The approach from MediaWiki 1.34 and earlier, of registering hook handlers directly as static methods, remains supported and is not deprecated. Extension authors may opt-in to the new system are welcome to do so. To learn more, see the MediaWiki core: Hook specification and the announcement on wikitech-l.

Changes to hook names

Prior to MediaWiki 1.35, hooks sometimes included characters that could not be used in a class or method name, such as colons and dashes. With the introduction of per-hook interfaces, the canoncal names of these hooks have been changed to use underscores instead. For example, the interface for ApiFeedContributions::feedItem is. Hook handers that are registered with the old names remain supported.

Registering hooks using HookHandlers

To adopt the new system, changes your Hooks class to have regular methods instead of static methods and be contructable. This class is then registered once, via the HookHandlers attribute in extension.json, using the  option as part of an ObjectFactory description where you can use the   option.

For example, to register the BeforePageDisplay hook:

Handling hooks using interfaces

To use hook interfaces, extensions should define a Hooks class in their namespace and implement one or more hook interfaces. Hook interfaces are named with the hook name followed by the word "Hook".

Convert an extension to the new hook system:

Follow these steps for each hook handling method:
 * identify the hook handler interface, and make the Hooks class implement this interface.
 * update the method name and signature to be exactly the same as in the interface.
 * change the "Hooks" section of extension.json to refer to the handler you specified in the "HookHandlers" section.

The process was demonstrated at the Wikimedia Hackathon 2021:
 * Example patch for an extension
 * Recording on YouTube



Hook-Verhalten vor MediaWiki 1.22 und danach
Extracted from: change 500542: for non-abortable hooks (most hooks) returning true has been redundant since MediaWiki 1.22 (in 2015). This was done to reduce chances of accidental failure because we had experienced several outages and broken features due to silent failures where e.g. one hook callback somewhere accidentally returned a non-bool or false instead of true/void and thus short-circuits the whole system.

(Returning non-true/non-void in a MediaWiki Hook is equivalent to  and   in JavaScript events, it kills other listeners for the same event).

For example, if  hook were to return false in MobileFrontend, it would mean Popups stops because its callback would no longer run. Siehe Unterschiede unten, unter der Annahme des Hooks.

Vor MediaWiki 1.22

oder

MediaWiki 1.22+

Dokumentation
Currently, hooks in MediaWiki core have to be documented both in hook interface (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.

Each hook provided by MediaWiki Core is defined in a hook interface. Typically, hook interfaces are located in a "Hook" sub-namespace inside the caller namespace. Beispielsweise. You can find a list of hook interfaces in the generated MediaWiki PHP documentation.

Um einen Hook im Wiki zu dokumentieren, verwende MediaWikiHook.

 Hook interface doc template 

In hook interfaces, doc comments specify the status, purpose, parameters, and behavior of the hook.



Verfügbare Hooks


Hooks gruppiert nach Funktion
Some of these hooks can be grouped into multiple functions.
 * Abschnitte: Artikelmanagement - Edit Page  -  Page Rendering  - Benutzeroberfläche - Dateiverwaltung - Spezialseiten - Benutzerverwaltung - Protokollierung -  Skinning Templates  - API - Import/Export -  Diffs  - Sonstiges



Alphabetische Liste der Hooks
Für eine vollständige Liste der Hooks, benutze die, welche mehr auf dem Laufenden gehalten werden sollte.

Fußnoten


Siehe auch

 * — specification of the hooks system
 * List of hook interfaces in MediaWiki Core
 * — enthält Beispiele von Hooks
 * — the JavaScript/front-end system of hooks
 * — specification of the hooks system
 * List of hook interfaces in MediaWiki Core
 * — enthält Beispiele von Hooks
 * — the JavaScript/front-end system of hooks