ProcessWire - Hooks - Versionsgeschichte

134.3.74.15: /* Beispiele für Hooks */

2022-02-08T11:17:58Z

Beispiele für Hooks

109.192.169.230: /* Feld manipulieren */

2021-01-30T06:25:56Z

Feld manipulieren

109.192.169.230: /* Wo kann man Hooks definieren */

2021-01-30T06:24:55Z

Wo kann man Hooks definieren

37.49.72.8: /* Fall-Beispiele */

2020-11-26T18:48:18Z

Fall-Beispiele

37.49.72.8: /* Wie wird er aufgerufen? */

2020-11-26T18:08:39Z

Wie wird er aufgerufen?

37.49.72.8: /* Wie wird er aufgerufen? */

2020-11-26T17:55:09Z

Wie wird er aufgerufen?

37.49.72.8: /* Wie wird er aufgerufen? */

2020-11-26T17:53:13Z

Wie wird er aufgerufen?

37.49.72.8: /* Wie nutze ich Hooks in der Praxis? */

2020-11-26T17:48:29Z

Wie nutze ich Hooks in der Praxis?

37.49.72.8: /* Wie kann man den Rückgabewert einer Hookable Funktion manipulieren */

2020-11-26T17:22:15Z

Wie kann man den Rückgabewert einer Hookable Funktion manipulieren

37.49.72.8: /* So definiert man Hooks */

2020-11-26T16:55:03Z

So definiert man Hooks

@@ Zeile 219: / Zeile 219: @@
 == Beispiele für Hooks ==
 === Basic Starter Hook ===
 Erster Schritt zum ausprobieren
@@ Zeile 370: / Zeile 371: @@
+     }
    });
 </syntaxhighlight>

@@ Zeile 237: / Zeile 237: @@
 </syntaxhighlight>
-=== Feld manipulieren ===
+=== Feld beim Speichern manipulieren ===
 Beim Speichern einer Seite ein Feld anpassen
 <syntaxhighlight lang="php">

@@ Zeile 178: / Zeile 178: @@
 Es bieten sich folgende Stellen an:
-* In einem eigenen Plugin
+* '''In einem eigenen Plugin'''
-** in der init() Funktion wenn er vor dem Verarbeiten des Request vorhanden sein muss
+** in der '''init()''' Funktion wenn er '''vor dem Verarbeiten des Request''' vorhanden sein muss
-** in der ready() Funktion wenn das Page Objekt schon bekannt sein muss (dann benötigst du ein autoload Modul)
+** in der '''ready()''' Funktion wenn das '''Page Objekt schon bekannt''' sein muss (dann benötigst du ein autoload Modul)
-* in den Dateien ready.php und init.php
+* in den '''Dateien ready.php und init.php'''
 ** Hier gilt das gleiche wie beim Plugin
-* in admin.php
+* in '''admin.php'''
-** dieses File wird nur bei Backend Zugriffen genutzt. Also cool um im Backen etwas zu erledigen.
+** dieses File wird nur '''bei Backend Zugriffen''' genutzt. Also cool um im Backen etwas zu erledigen.
-* In einem Template
+* In einem '''Template'''
 ** z.B. in einem dass über config.php $config->prependTemplateFile = meinHauptTemplate definiert wurde. Hier ganz oben, dann hat man viele Möglichkeiten.

@@ Zeile 58: / Zeile 58: @@
 // INNERHALB einer Klasse mit FUNKTIONSNAME als 3.Argument - 'myHookMethodName' ist eine public method dieser Klasse und kann direkt aufgerufen werden.
-// Der zweite Parameter ist keine anonyme Funktion mehr. Man übergibt einfach $this als 2.Parameter.
+// Der zweite Parameter ist keine anonyme Funktion mehr. In dem Objekt den man hier übergibt "lebt" die Hook-Methode. Oft übergibt einfach $this oder null als 2.Parameter.
 $this->addHookAfter('Class::method', $this, 'myHookMethodName');

@@ Zeile 49: / Zeile 49: @@
 Als '''Argumente des Hook''' übergibt man den '''Namen der Hook-Funktion''' (hookable Method)'''und eine Funktion''' die für dich etwas tun soll. Diese Funktion bekommt ein '''Objekt vom Typ Hookable Event'''. Dieses Objekt läßt einen auf die wichtigen Dinge in der Hookable Function zugreifen.
-'''Fall-Beispiele'''
+====Fall-Beispiele====
 <syntaxhighlight lang="php">
-// INNERHALB einer Klasse (deshalb funktioniert $this), Funktion als ANONYME FUNKTION direkt im Aufruf
+// INNERHALB einer Klasse (deshalb funktioniert $this->addHookAfter), Funktion als ANONYME FUNKTION direkt im Aufruf
 $this->addHookAfter('Class::method', function($event) {
    // function implementation
 });
-// INNERHALB einer Klasse mit FUNKTIONSNAME - 'myHookMethodName' ist eine public method dieser Klasse und kann direkt aufgerufen werden.
+// INNERHALB einer Klasse mit FUNKTIONSNAME als 3.Argument - 'myHookMethodName' ist eine public method dieser Klasse und kann direkt aufgerufen werden.
 $this->addHookAfter('Class::method', $this, 'myHookMethodName');
 // AUßERHALB einer Klasse nutzt man $wire oder wire()
@@ Zeile 66: / Zeile 68: @@
-// Aufruf über FUNKTIONSNAME: Du gibst den Funktionsnamen an und die Funktion 'myHookFunctionName' wird separat definiert.
+// AUßERHALB einer klasse Aufruf über FUNKTIONSNAME: Du gibst den Funktionsnamen an und die Funktion 'myHookFunctionName' wird separat definiert.
 wire()->addHookAfter('Class::method', null, 'myHookFunctionName');
 // Hooks gelten in der Regel für alle Instanzen eines Objekts (z.B. alle Seiten)
@@ Zeile 92: / Zeile 96: @@
 '''HINWEIS:''' Bei den folgenden Beispielen lassen wir die Definition des Hook weg und zeigen nur wie man mit dem Event Objekt umgeht. Zum Testen brauchst du also immer noch einen Hook aufruf der die Beispielfunktion triggert. Also etwas in der Art:
   wire()->addHookAfter('Class::method', null, 'myHookFunctionName');
 ==== Das HookEvent Objekt ====

← Nächstältere Version		Version vom 26. November 2020, 17:55 Uhr
Zeile 89:		Zeile 89:

	</syntaxhighlight>		</syntaxhighlight>
		+
		+	'''HINWEIS:''' Bei den folgenden Beispielen lassen wir die Definition des Hook weg und zeigen nur wie man mit dem Event Objekt umgeht. Zum Testen brauchst du also immer noch einen Hook aufruf der die Beispielfunktion triggert. Also etwas in der Art:
		+	wire()->addHookAfter('Class::method', null, 'myHookFunctionName');

	==== Das HookEvent Objekt ====		==== Das HookEvent Objekt ====

@@ Zeile 34: / Zeile 34: @@
 === Wie nutze ich Hooks in der Praxis? ===
 ==== Welchen soll ich nehmen? ====
 Zunächst mal gibt es drei Funktionen mit denen seine eigenen Funktionen einklinkt:
@@ Zeile 89: / Zeile 90: @@
 </syntaxhighlight>
 ==== Wie kann ich mit einem Hook Argumente modifizieren? ====
 ''' Argumente lesen... '''
-Lesen möchte man '''meistens im addHookBefore'''. Denn dann kann man die Werte nochmal verändern bevor sie durch die Funktion geschickt werden.
+Arugemente lesen möchte man '''meistens im addHookBefore'''. Denn dann kann man die Werte nochmal verändern bevor sie durch die Hookable Funktion geschickt werden.
 Das HookEvent Objekt hat eine arguments() Methode über die man die Argumente die in der original Methode übergeben werden (die mit den ___) abgreifen kann. Das funktioniert über den index oder den Namen des Arguments:
@@ Zeile 125: / Zeile 129: @@
 </syntaxhighlight>
-==== Wie kann man den Rückgabewert einer Hookable Funktion manipulieren ====
+==== Wie kann man den Rückgabewert einer Hookable Funktion manipulieren ?====
 Das macht man mit dem addHookAfter. Diesen setzt man in der Regel auf Ausgabewerte einer Funktion an.
@@ Zeile 133: / Zeile 138: @@
   $event->return = $derNeueRückgabewert.
 Beispiel siehe unten.
 ==== Wo kann man Hooks definieren ====
 Es bieten sich folgende Stellen an:
 * In einem eigenen Plugin
@@ Zeile 149: / Zeile 182: @@
 * Überall wo die Elternklasse verfügbar ist.
+==== Was geht sonst so? ====
+* Neue Funktionen injecten (mit addHook)
+* Neue Eigenschaften injecten
+* ... Siehe Link oben
 <syntaxhighlight lang="php">
 </syntaxhighlight>