Benutzerdefinierte Filter mit Shortcodes verwenden
Sobald Sie die Shortcode-API und die Funktionsweise von Filtern verstanden haben, ist es einfach, sie in WordPress zu implementieren.
Und wenn Sie beides mischen können, können Sie viel mehr als sonst tun, als wenn sie unabhängig voneinander arbeiten.
Insbesondere können Sie Daten filtern, die im Ergebnis des Shortcodes enthalten sind, was für andere Entwickler besonders nützlich sein kann. Wenn Sie mit der Implementierung benutzerdefinierter Filter vertraut sind, ist dies im Kontext eines Kurzcodes nicht viel anders.
Aber wenn Sie noch nie zuvor die Shortcode-API oder die Funktionalität verwendet haben, ist dies immer noch einfach.
Benutzerdefinierte Filter mit Shortcodes
Für diesen Beitrag verwenden wir ein relativ erfundenes Beispiel. Das heißt, der Shortcode führt zu etwas Statischem. Der Grund dafür ist, dass es einfach ist, in einem Beitrag zu demonstrieren und in Ihrem Code zu implementieren.
Der Kurzcode
Um einen Shortcode zu implementieren, benötigen Sie zwei Dinge:
- einen benutzerdefinierten Namen für den Shortcode,
- eine Funktion, die verwendet wird, um Informationen überall dort abzulegen, wo der Shortcode verwendet wird.
Hinweis im obigen Code; Ich habe der Funktion ein Präfix vorangestellt. __NAMESPACE__Dies liegt daran, dass sich die Funktion in einem benutzerdefinierten Namespace befindet (den Sie oben in der Datei sehen können).
Ohne dieses Präfix wird die Funktion nicht aufgerufen. Wenn Sie sich gegen die Verwendung von Namespaces entscheiden, können Sie sowohl auf das Präfix als auch auf die führenden Schrägstriche Ihres Funktionsnamens verzichten.
Beachten Sie, dass wir diese Funktion erneut besuchen werden, sobald wir den Filter eingerichtet haben.
Der Filter
Das Hinzufügen eines benutzerdefinierten Filters ähnelt dem Hinzufügen eines Shortcodes. Du brauchst:
- ein benutzerdefinierter Filtername,
- eine Funktion, die zum Filtern der eingehenden Informationen verwendet wird (und Filter sollten im Allgemeinen mindestens einen Parameter akzeptieren, bei dem es sich natürlich um die zu filternden Daten handelt):
Um mit dem obigen Beispiel konsistent zu bleiben, sagen wir, dass wir nur ein paar Wörter im Shortcode ersetzen möchten :
Dies ersetzt den Inhalt von:
Dies ist das Ergebnis eines Beispiel-Shortcodes.
Zu:
Dies ist das Ergebnis eines gefilterten Shortcodes.
Aber wir müssen die beiden noch aneinander binden.
Wiedersehen mit dem Shortcode
Um die beiden Funktionen miteinander zu verknüpfen, müssen wir sicherstellen, dass die Funktion für den Shortcode den Filter auf den zurückgegebenen Wert anwendet.
Glücklicherweise ist die Implementierung einfach, zumal wir alles haben, was wir brauchen:
In einem ganz konkreten Beispiel empfehle ich immer zu überprüfen, ob das Ergebnis des Parameters nicht leer ist, ob es die gesuchte Zeichenfolge enthält, oder etwas Ähnliches.
Das heißt, ich öffne oft gerne mit einer Schutzklausel. Wenn der Test fehlschlägt, gebe ich einfach den eingehenden Wert zurück; Andernfalls filtere ich die Daten und gebe das Ergebnis dieser Operation zurück.