Wordpress Short Codes
- Stephan Venus
Um die Venus-Web-Module in WordPress korrekt integrieren zu können, werden sogenannte Shortcodes verwendet, die innerhalb des jeweiligen WP Page Builders genutzt werden können. Innerhalb eines Shortcodes können verschiedene Parameter definiert werden, die unterschiedliche Zwecke erfüllen.
Im folgenden Artikel werden diese Shortcode-Parameter sowie ihre möglichen Werte aufgelistet und erläutert. Ein Beispiel für einen ausführlichen WP-Shortcode (Auflistungsdarstellung) samt Filter-, Sortier-, Menü- und Styling-Optionen:
[we2p_module type="we2p_adapter_webmodule" we2p_listing_template="listing" we2p_filter_link="/type=Event" we2p_disabled_filters="city" we2p_sort_function="name" we2p_sort_order="1" we2p_color_primary="#000000" we2p_color_secondary="#ffffff"][/we2p_module]
Die Initialseiten Parameter: we2p_module type
Bei den Initialseiten Parametern unterscheidet man generell zwischen drei Abfragen, welche den Basis-Rahmen des Shortcodes bilden:
1. Auflistungen: we2p_module type="we2p_adapter_webmodule"
Dieser Initialseiten-Typ ist der wohl am häufigsten genutzte Type, da damit Ergebnislisten für Landingpages erstellt werden können.
Der Basis Module Type für die Einbindung von Auflistungen lautet:
[we2p_module type="we2p_adapter_webmodule"][/we2p_module]
Weitere Parameter (z.B. Die Filterabfrage, die Sortierung, usw.) müssen innerhalb des ersten Teils des Shortcodes definiert werden und mit einem Leerzeichen voneinander getrennt sein.
Ein Beispiel hierfür wäre:
[we2p_module type="we2p_adapter_webmodule" we2p_listing_template="listing" we2p_filter_link="/type=FoodEstablishment" we2p_disabled_filters="city" we2p_sort_function="random"][/we2p_module]
2. Detailseiten: [we2p_module type="we2p_adapter_detailpage"][/we2p_module]
Dieser Initialseiten-Typ wird verwendet, wenn man eine Standalone Detail-Unterseite integrieren möchte.
Der Basis Module Type für die Einbindung von Detailunterseiten lautet:
[we2p_module type="we2p_adapter_detailpage"][/we2p_module]
Logischerweise sollte man spezifizieren welcher Datensatz dargestellt werden soll. Dies wird über den Parameter we2p_detail_id definiert.
Ein Beispiel hierfür wäre:
[we2p_module type="we2p_adapter_detailpage" we2p_detail_id="62a9beb77ee0232ba3247110"][/we2p_module]
3. Kartendarstellung: [we2p_module type="we2p_adapter_map"][/we2p_module]
Dieser Initialseiten-Typ wird verwendet, wenn man eine Full-Screen-Kartendarstellung abbilden möchte.
Der Basis Module Type für die Einbindung der Full Size Map lautet:
[we2p_module type="we2p_adapter_map"][/we2p_module]
Weitere Parameter wie z.B. die Filterabfrage müssen innerhalb des ersten Teils des Shortcodes definiert werden und mit einem Leerzeichen voneinander getrennt sein. Eine Sortierung und Menü-Einschränkungen finden hier nicht statt.
Ein Beispiel hierfür wäre:
[we2p_module type="we2p_adapter_webmodule" we2p_filter_link="/type=Hotel"][/we2p_module]
Der Template Parameter: we2p_listing_template
Der “Template” Parameter übermittelt die Information, in welchem Format die jeweiligen abgerufenen Daten dargestellt werden sollen. Hierbei kann man auf verschiedene Listen und/oder Karten Darstellungen zurückgreifen.
Beim “Template” Parameter handelt es sich um einen einfachen String Parameter, welcher wie folgt aufgebaut werden kann:
we2p_listing_template="listing"
Als mögliche Werte für den Template Parameter stehen Ihnen diese Optionen zur verfügung:
Die Listenansicht: we2p_listing_template=”listing”
Die Spalten-Ansicht: we2p_listing_template=”grid”
Die Standalone Karten-Ansicht: we2p_listing_template=”maps”
Die Slider-Ansicht: we2p_listing_template=”slide”
Die Listen-Karten Kombination: we2p_listing_template=”listing-maps”
Die Grid-Karten Kombination: we2p_listing_template=”grid-maps”
Die zweispaltige Listen-Karten Kombination: we2p_listing_template=”split-maps”
Der Filter-Link Parameter: we2p_filter_link
Über den Filter-Link-Parameter wird geregelt, welche Daten aus dem Venus Knowledge Graph tatsächlich abgerufen werden. Hier bei lassen sich verschiedenste Suchanfragen gegen die Datenbank formulieren, welche genauer in der folgenden Dokumentation definiert werden. Darin werden alle Filteroptionen erläutert, sowie auf die Kombinationsmöglichkeiten eben jener Filterwerte eingegangen.
Dokumentation zu den jeweiligen Filter-Parametern
Dokumentation zur Kombination von Filter-Parameter
Beispiel für einen komplexen Filter-Link:
Abfrage aller Gastronomie Betriebe, In München und Frankfurt, welche Vegetarische Gerichte anbieten.
we2p_filter_link="/type=FoodEstablishment/city=München:Frankfurt/cuisine=vegetarian"
Wichtig: Die jeweiligen Filterparameter beginnen immer mit einem Slash “/“ !
Unterschiedliche Filter-URL-Parameter sind somit immer zu trennen.
Detailseiten Parameter: we2p_detail_id
Um einen einzelnen Datensatz in der Detailansicht abbilden zu können wird nicht der Filter-Parameter genutzt, sondern der Detail-ID Parameter. Bei diesem Parameter wird als Wert die entsprechende MongoID des gewünschten Datensatzes genutzt.
Beispiel für die Detailseiten-Abfrage:
we2p_detail_id="62a9beb77ee0232ba3247110"
Die MongoID kann man entweder aus der jeweiligen URL des Datensatzes im Knowledge Graph oder aus dem Venus Extension entnehmen, oder kann direkt aus dem Venus Knowledge Graph Detail-Pflege User Interface direkt entnommen werden.
Filtermenü Konfigurieren: we2p_disabled_filters
Die Venus Knowledge Graph Extension ist mit vielen verschiedenen Filteroptionen versehen, welche sich normalerweise von selbst in einer entsprechenden Filternavigation aufbauen, abhängig von den jeweiligen Daten, welche über den Shortcode abgerufen werden sollen.
Es besteht aber auch die Möglichkeit gezielt Filter-Optionen in diesem Menü zu deaktivieren. Dabei wird der we2p_disabled_filters Parameter angewandt. Es können auch mehrere Filter-Optionen gleichzeitig deaktiviert werden.
Die folgenden Filter-Menü-Optionen können deaktiviert werden:
Orte: "city"
Themen: "topic"
Kategorien: "type"
Ausstattung: "feature"
Zeitraum: "timeRange"
Alle weiteren Filter: "others"
Küchenarten: "cuisine"
Zielgruppe: "audience"
Gütesiegel: "qualityLabel"
Art der Loipe: "typeOfCrossCountrySkiTrail"
Klassifizierung: "classification"
Produkte: "products"
Länge: "length"
Dauer: "duration"
Höhenmeter: "ascent"
Angebote: "services"
Ein Beispiel für ein eingeschränktes Filtermenü wäre:
we2p_disabled_filters="city,topic,feature,cuisine,others"
Sortierung der Ergebnisliste: we2p_sort_function
Die gewünschte Ergebnisliste kann mit Hilfe des we2p_sort_function Parameters nach spezifischen Sortierungsregeln gegliedert werden. Die folgenden Sortierungsmöglichkeiten können konfiguriert werden:
Name (alphabetisch): "name"
Ort (alphabetisch): "city"
Neueste Datensätze: "newest"
Nächste Termine: "time"
Geöffnet (nur Schneebericht): "open"
Zufällig: "random"
Entfernung von Punkt: "distance"
Klassifizierung: "classification"
Länge (z.B. Touren): "length"
Dauer (z.B. Touren): "duration"
Aufstieg (z.B. Touren): "ascent"
Highlights (alphabetisch): "sticky"
Ein Beispiel für eine alphabetische Sortierung abhängig vom Ortsnamen wäre:
we2p_sort_function="city"
Sonderfall: Sortierungen die von einer Geo-Koordinate ausgehen werden mit zusätzlichen Parametern definiert!
In diesem Fall müssen Longitude wie auch Latitude mit den entsprechenden Koordinaten definiert werden:
we2p_geosort_lat="48.9174654"
we2p_geosort_long="12.6893591"
Sortierung Absteigend oder Aufsteigend: we2p_sort_order
Ergänzend zum we2p_sort_fuction Parameter kann über we2p_sort_order definiert werden, ob eine Ergebnisliste auf oder absteigend ausgespielt werden soll.
“0“ steht in diesem Fall für “Aufsteigend”
“1“ steht in diesem Fall für “Absteigend”
Ein Beispiel für eine absteigende Sortierung wäre:
we2p_sort_order="1"
Filter-Menü deaktivieren: we2p_show_menu=”false”
Mit diesem Parameter kann das Filtermenü der Venus Extension deaktiviert werden, damit eine Standalone Ergebnisliste dargestellt wird.
we2p_show_menu="false"
Farben ändern: Primär-Farbe und Sekundär-Farbe
Es ist möglich die Default Primär und/oder Sekundär Farbe zu überschreiben, in dem man die Parameter we2p_color_primary und we2p_color_secondary verwendet. Hierbei müssen sogenannte Hex-Code Farbwerte hinterlegt werden mit denen man den Default-Farbwert überschreiben möchte.
we2p_color_primary="#000000"
we2p_color_secondary="#ffffff"