Frontend-Komponenten

Mit Kickstart sind “out of the box” eine Immobilien-Übersichtsseite sowie eine vollständige Detailansicht verfügbar – jeweils inkl. Seitenleiste zur Ergänzung von Widgets. Die vom Plugin bereitgestellten Immobilien-Komponenten können aber auch mit den folgenden Shortcodes in beliebiger Anzahl und Kombination in Seiten oder andere Inhaltselemente eingefügt werden.

Die in der gleichen Seite eingebundenen Komponenten sind grundsätzlich unabhängig voneinander, beeinflussen sich also nicht direkt gegenseitig. So wirkt sich bspw. die Änderung einer Auswahl im Suchformular erst nach dem Absenden bzw. dem Aktualisieren der kompletten Seite auf eine Listenansicht aus. Auch die Konfiguration einer Komponente per Shortcode-Attribut wirkt sich nicht automatisch auf die anderen Komponenten der Seite aus.

Eine komponentenübergreifende Konfiguration ist aber mittels GET-Parametern möglich.

Suchformular

[inx-search-form]

Das Formular für die Suche nach Immobilien enthält in der Standardkonfiguration relativ umfangreiche Auswahlmöglichkeiten inkl. Umkreissuche etc. Mit den Attributen elements und exclude kann eine individuelle Auswahl an Elementen definiert werden.

Beispiele

nur Nutzungsart, Objektart und Absenden-Button einbinden:
[inx-search-form elements="type-of-use, property-type, submit"]

Auswahl der Immobilien- und Vermarktungsart nicht einbinden:
[inx-search-form exclude="property-type, marketing-type"]

Details und vollständige Elementliste: Komponenten → Suchformular

Sortierung

[inx-filters-sort]

Mit diesem Shortcode wird aktuell bei Verwendung des Standard-Skins ein Balken mit einer einzelnen Dropdown-Auswahlliste gängiger Sortiermöglichkeiten eingebunden. Hier könnten zukünftig weitere Optionen in Sachen Filterung ergänzt werden.

Für die explizite Festlegung der Elemente der Auswahlliste bzw. das Ausschließen bestimmter Elemente stehen die optionalen Shortcode-Attribute elements und exclude zur Verfügung, die jeweils kommagetrennte Listen von Element-Keys enthalten können. Ebenfalls optional ist das Attribut default, mit dem Standardsortierung festgelegt werden kann.

Die per Shortcode-Attribut übergebene Standardsortierung hat keinen direkten Einfluss auf die eigentliche Sortierung der in der gleichen Seite enthaltenen Immobilien-Liste. Diese Angabe kann “global” per GET-Parameter oder Filterfunktion gesetzt werden oder alternativ auch im Listen-Shortcode hinterlegt werden. (Bei den GET- und Filter-Varianten wird das default Attribut nicht benötigt.)

Beispiele

nur Preis auf- oder absteigend (Standard) als Sortieroptionen
[inx-filters-sort elements="price_asc, price_desc" default="price_desc"]

Fläche und Zimmeranzahl aus der Optionsliste entfernen
[inx-filters-sort exclude="area_asc, rooms_asc"]

Details: Komponenten → Sortierung

Listenansicht

[inx-property-list]

Umfang, Art und Sortierung der angezeigten Immobilien können mit Shortcode-Attributen bestimmt werden, nachfolgend die gängigsten. Bei der taxonomiebasierten Auswahl und der Sortierung sind auch mehrere, kommagetrennte Angaben möglich.

Details und weitere Attribute: Komponenten → Listenansicht

Seitennavigation

[inx-pagination]

Hiermit wird die Standard-Seitennavigation in der vom Theme vorgegebenen Optik eingebunden.

Details: Komponenten → Seitennavigation

Immobilien-Details

Achtung! Die folgenden Shortcodes kommen nur dann zum Einsatz, wenn eine Seite als Rahmenvorlage für die Immobilien-Details verwendet wird. Bei der Nutzung des Standard-Templates des Immobilien-Beitragstyps werden sie nicht benötigt.

Wurde eine Seite als Vorlage für die Detailansicht ausgewählt, können hier per Shortcode die gewünschten Immobilien-Inhalte in die gewünschten Layout-Container-Elemente eingebettet werden - komplett, abschnittsweise oder bei Bedarf auch granular in Form einzelner Angaben.

Alle Details oder bestimmte Abschnitte

[inx-property-details]

Der einfachste Anwendungsfall ist der Shortcode ohne Attribute: Hiermit werden alle verfügbaren Detailabschnitte eingebunden. Die Abschnitte enthalten jeweils thematisch gruppierte Daten in einem hierzu passenden Layout.

Elemente einbinden

[inx-property-details elements="ELEMENT_KEY1, ELEMENT_KEY2..."]

Mit dem Attribut elements kann explizit festgelegt werden, welche Abschnitte (Elemente) mit dem Shortcode eingebunden werden sollen. Als Attributwert wird hierbei ein einzelner Element-Key oder eine kommagetrennte Liste mehrerer Keys hinterlegt.

Jedem Element können zusätzliche Attribute (z. B. eine Absatzüberschrift) nach dem Schema ELEMENT_KEY-attribut="ATTRIBUTWERT" zugeordnet werden. Diese werden dann beim Rendern des zugehörigen Element-Templates berücksichtigt. (Wird nur ein einzelnes Element mit dem Shortcode eingebunden, kann das Präfix ELEMENT_KEY- weggelassen werden.)

Beispiele

Haupt-Beschreibungstext der Immobilie einfügen:
[inx-property-details elements="main_description"]

Abschnitt mit Preisangaben und Überschrift “Preise” einfügen:
[inx-property-details elements="prices" headline="Preise"]

Fotogalerie und Abschnitt für Ausstattungsmerkmale einfügen, letzterer mit Überschrift “Ausstattung”:
[inx-property-details elements="gallery, features" features-headline="Ausstattung"]

Elemente ausschließen

[inx-property-details exclude="ELEMENT_KEY1, ELEMENT_KEY2..."]

Alternativ können mit exclude bestimmte Elemente von der Einbindung ausgenommen werden.

Beispiele

Alle Abschnitte mit Ausnahme von Header und Footer anzeigen:
[inx-property-details exclude="head, footer"]

Einzelne Angaben

[inx-property-detail-element name="ELEMENT_ODER_FELDNAME"]

Mit diesem Shortcode können einzelne Werte, die per WordPress-OpenImmo-Schnittstelle importiert wurden, in die Immobilien-Detailseite eingefügt werden. Der per Attribut übergebene Elementname kann sich hierbei auf folgende Quellen beziehen:

Ausschnitt aus der OpenImmo2WP-Mapping-Tabelle für Kickstart
Ausschnitt aus der OpenImmo2WP-Mapping-Tabelle für Kickstart

Mit weiteren Shortcode-Attributen, z. B. type, template und if_empty kann die Darstellung des Elements genauer definiert werden.

Beispiele

Grundstücksfläche anzeigen:
[inx-property-detail-element name="flaechen.grundstuecksflaeche"]

Primäre Preisangabe anhand des Custom-Field-Namens abrufen und formatiert anzeigen:
[inx-property-detail-element name="_inx_primary_price" type="price"]

Alternative Variante der Preiseinbindung mit identischer Ausgabe:
[inx-property-detail-element name="primaerpreis" template="{value,number,2} {currency_symbol}"]

Energieverbrauchskennwert per XPath-Angabe ermitteln und Alternativtext anzeigen, falls nicht verfügbar:
[inx-property-detail-element name="//zustand_angaben/energiepass/energieverbrauchkennwert" if_empty="Energieausweis in Vorbereitung"]


Details, weitere Optionen und vollständige Elementliste: Komponenten → Detailansicht

GET-Parameter

Kickstart-spezifische GET-Parameter werden an die URL der jeweiligen Seite angehangen und wirken sich auf die Ausgabe aller betroffenen Komponenten aus, die hier per Shortcode eingebundenen wurden. Wird also hierüber bspw. eine bestimmte Objektart oder eine Sortierung vorgegeben, werden diese Optionen auch im Suchformular bzw. der Sortierungs-Auswahlbox voreingestellt.

Die möglichen Angaben entsprechen weitgehend denen, die nach dem Absenden des Standard-Suchformulars in der URL der Ergebnisseite enthalten sind. Hinzu kommen die Status-Flags für die Selektion von Referenzobjekten & Co. sowie weitere allgemeine Parameter (Ländercode, Objektanzahl, Sortierung etc.).

Die Namen der Parameter beginnen immer mit dem Präfix inx- oder inx-search-. Bei taxonomiebasierten Parametern werden die zugehörigen Term-Slugs als Werte übergeben (einzeln oder als kommagetrennte Liste).

Parameter Beschreibung / Werte
inx-search-description Schlüsselwortsuche in Titeln, Beschreibungstexten und weiteren Feldern (z. B. Objekt-ID)
inx-search-type-of-use Nutzungsart (Term-Slugs der Taxonomie inx_type_of_use)
inx-search-property-type Objektart (Term-Slugs der Taxonomie inx_property_type)
inx-search-marketing-type Vermarktungsart (Term-Slugs der Taxonomie inx_marketing_type)
inx-search-locality Ort (Term-Slugs der Taxonomie inx_location)
inx-search-features Ausstattung (Term-Slugs der Taxonomie inx_features)
inx-search-labels Labels (Term-Slugs der Taxonomie inx_labels)
inx-search-min-rooms Mindestanzahl Zimmer/Räume (Ganzzahl)
inx-search-min-area Mindestfläche in m² (Ganzzahl)
inx-search-price-range Preisrahmen (MIN,MAX, z. B. 200000,400000)
inx-author Objekte nach Autor(en) filtern (kommagetrennte Liste von Benutzer-IDs oder Login-Namen; Minus zum Ausschließen bestimmter Benutzer, z. B. 128,264, maklerx,agentur-y,dieter.demo oder -1,-2,-10)
inx-iso-country nur Objekte im Land mit den angegebenen ISO3-Ländercodes anzeigen (z. B. DEU oder DEU oder DEU,AUT,ESP)
inx-references Referenzen anzeigen? (yes = ja, no = nein (Standard), only = ausschließlich)
inx-available nur explizit verfügbare Objekte anzeigen? (yes = ja, no = nein)
inx-reserved nur explizit reservierte Objekte anzeigen? (yes = ja, no = nein)
inx-sold nur explizit verkaufte/vermietete Objekte anzeigen? (yes = ja, no = nein)
inx-featured nur explizit empfohlene Objekte anzeigen? (yes = ja, no = nein)
inx-front-page-offer nur explizit als Startseiten-Angebot markierte Objekte anzeigen? (yes = ja, no = nein)
inx-demo Beispiel-/Demo-Objekte bei der Ausgabe berücksichtigen? (no = nein, only = ausschließlich)
inx-limit Gesamtanzahl der anzuzeigenden Immobilien begrenzen (Ganzzahl)
inx-limit-page Anzahl der anzuzeigenden Immobilien pro Seite begrenzen (Ganzzahl)
inx-sort Sortierschlüssel (Key)
inx-force-lang Sprachcode, mit dem in Sonderfällen bei mehrsprachigen Umgebungen eine bestimmte Sprache vorgegeben werden kann (z. B. de, en…)
inx-ref beliebiger, benutzerdefinierter Wert

Beispiel-URLs

Nur zu verkaufende Einfamilienhäuser anzeigen:
https://www.immobilienmakler-website.de/immobilien/?inx-search-property-type=einfamilienhaus&inx-search-marketing-type=zu-verkaufen

Barrierefreie Immobilien mit Wintergarten anzeigen:
https://www.immobilienmakler-website.de/immobilien/?inx-search-features=barrierefrei,wintergarten

Maximal fünf Objekte nach Preis absteigend sortiert anzeigen:
https://www.immobilienmakler-website.de/immobilien/?inx-limit=5&inx-sort=price_desc