• Systemvoraussetzungen
• Schnellstart
• Installation
• Basiskonfiguration
  • Tab „Allgemein“
  • Tab „E-Mail“
  • Tab „Google Maps“
  • Tab „Wertermittlung“
    • Wertermittlung mit ImmobilienScout24
    • Wertermittlung mit PriceHubble
    • Bewertungsdaten im Lead-Formular (Frontend)
  • Tab „Lizenz“
• Einbindung
  • Fast Forward
• Lead-Daten
• Formulare
  • Icons
  • Formularelemente
    • Auswahlkarten
    • Wertebereich-Slider
    • Dropdown-Auswahlbox
    • Einzelnes Eingabefeld
    • Flexible Eingaben/Auswahl
    • Standort-Auswahl/Eingabe
    • Kontaktdatenformular
    • Allgemeine Texte für Kontaktdaten-Elemente (formularübergreifend)
  • Speichern, Import & Export
• Übersetzung
  • Interne Plugin-Texte übersetzen mit Gettext
  • Formularinhalte übersetzen mit Polylang oder WPML
  • Mehrsprachige Standard-Formulare
• Individuelle Anpassungen
  • CSS per Customizer
  • Anpassungen im Child-Theme
  • Anpassung und Ergänzung von Formularelementen
  • Frontend-Themes
  • E-Mail-Vorlagen
• JavaScript-Events
  • immonexLeadGen:primaryPropertyTypeSelection_viewed
    • Meta-Daten (detail)
    • Beispielfunktion
  • immonexLeadGen:propertyTypeForm_selected
    • Meta-Daten (detail)
    • Beispielfunktion
  • immonexLeadGen:propertyTypeForm_navigated
    • Meta-Daten (detail)
    • Beispielfunktion
  • immonexLeadGen:propertyTypeForm_submitted
    • Meta-Daten (detail)
    • Beispielfunktion
• Filter-Referenz
  • immonex_lead_gen_notification_recipients
    • Parameter
  • immonex_lead_gen_notification_headers
    • Parameter
  • immonex_lead_gen_notification_subject
    • Parameter
  • immonex_lead_gen_notification_body
    • Parameter
  • immonex_lead_gen_oi_feedback_xml
    • Parameter

Systemvoraussetzungen

• PHP >= 7.2
• WordPress >= 5.0

Schnellstart

Kurz vorab: Die HAUPTsprache der Website sollte vor der Installation dieses Plugins bereits final eingestellt sein, da ansonsten möglicherweise die Standard-Formulardaten in der falschen Sprache installiert werden (Infos zur manuellen Installation einer bestimmten Sprachversion).

Dieses Plugin kann in wenigen, einfachen Schritten betriebsfertig eingerichtet werden:

1. Plugin installieren und aktivieren
2. Plugin unter Immobilen-Leads > Einstellungen grundlegend konfigurieren und Lizenz aktivieren
3. Shortcode [immonex-lead-generator] in der gewünschten Seite hinterlegen

Installation

1. WordPress-Dashboard: Plugins > Installieren > Plugin hochladen *
2. Plugin-ZIP-Datei auswählen und Installieren-Button klicken
3. Plugin nach erfolgreicher Installation aktivieren
4. Grundeinstellungen unter Immobilen-Leads > Einstellungen prüfen bzw. anpassen
5.  Passende API-Schlüssel in den Tabs „Google Maps“ und „Wertermittlung“ (optional) hinterlegen
6. Lizenzschlüssel im Tab „Lizenz“ hinterlegen und Lizenz aktivieren. That’s it!

* Alternativ: ZIP-Datei entpacken und ins Verzeichnis „wp-content/plugins“ kopieren, anschließend das Plugin im WordPress-Backend unter Plugins > Installierte Plugins aktivieren.

Basiskonfiguration

Das Plugin ist direkt nach der Installation bereits ohne weitere Einrichtungsschritte einsatzbereit, trotzdem sollten unter Immobilien-Leads > Einstellungen folgende Optionen geprüft und angepasst werden (vor allem die Google-Maps-Angaben):

Tab „Allgemein“

DEMO-Modus aktivieren
Ist der Demo-Modus aktiviert, werden keine Lead-Daten gespeichert und keine Mails versendet.

Frontend-Theme
Diese Auswahl ist für die grundlegende Optik der Formulare maßgeblich, die die Website-Besucher für die Übermittlung Ihrer Immobiliendaten verwenden. (Das hier ausgewählte Theme bezieht sich nur auf das Plugin und hat nichts mit dem WordPress-Theme der Website zu tun.)

Die beiden mitgelieferten Themes Heeba (Standardeinstellung) und Ulysses unterscheiden sich aktuell nur hinsichtlich der enthaltenen Icons – Layout und Typographie sind identisch. Hiervon abgeleitete oder komplett individuell gestaltete Varianten können bei Bedarf im Child-Theme-Ordner hinterlegt werden (siehe Individuelle Anpassungen).

Umschalten zwischen Immobilientypen
Mit dieser Option kann die Möglichkeit des Wechsels zu einem Formular eines alternativen Immobilientyps aktiviert werden, ohne dass hierfür die Seite neu geladen werden muss (nach der primären Auswahl auf der Einstiegsseite, in die der Lead Generator eingebunden ist).

Weiterleitungs-Seite/URL
Nach dem erfolgreichen Absenden einer Bewertungs-Anfrage wird in der Standardkonfiguration eine Infobox mit einer passenden Meldung angezeigt. Alternativ kann aber per Angabe einer Seiten-ID der aktuellen WordPress-Installation oder einer beliebigen URL in diesem Feld eine automatische Weiterleitung zu einer separaten Seite bzw. Web-Adresse aktiviert werden. Eine interne Seite kann hierbei auch für die direkte Anzeige der Ergebnisse von Vorab-Wertermittlungen für Häuser und Wohnungen genutzt werden, sofern die Anbindung an die API von ImmobilienScout24 aktiviert wurde.

Aktivieren auf Extra-Seiten
Die JavaScript- und CSS-Dateien des Lead Generators werden automatisch in alle Seiten eingebunden, bei denen der Shortcode [immonex-lead-generator] im Eingabefeld für den Hauptinhalt eingefügt wurde. Andere Arten der Einbindung, bspw. in einem benutzerdefinierten Feld, per Widget oder auf Codebasis werden nicht berücksichtigt.

Aus diesem Grund müssen die IDs solcher Seiten hier explizit angegeben werden (kommagetrennt). Soll der Lead Generator auf allen Seiten – z. B. in einem Headerbereich – zum Einsatz kommen, kann dies mit einem * bewerkstelligt werden.

Alternative Formularsets
Wenn der Lead-Generator in mehreren Bereichen der WordPress-Installation mit jeweils unterschiedlicher Formularkonfiguration eingesetzt werden soll, können hierfür bis zu zehn „alternative Formularsets“ angelegt werden. Diese können unabhängig voneinander konfiguriert und per Angabe der entsprechenden ID (laufende Nummer) eingebunden werden. Ist eine Anzahl alternativer Formularsets ausgewählt, sind die zugehörigen Konfigurationsseiten unter Immobillien-Leads > Formulare (1, 2, 3…) zu finden.

Tab „E-Mail“

Die E-Mail-Konfiguration ist in drei Abschnitte unterteilt (in separaten Tabs ab Plugin-Version 2.2.0):

• Im ersten können Empfänger und Inhalte der Nachricht festgelegt werden, die beim Eingang von neuen Leads an den Website-Betreiber bzw. Administrator gesendet wird.
• Die Angaben im zweiten Abschnitt/Tab beziehen sich auf die (standardmäßig aktivierte) Eingangsbestätigung, die an die jeweiligen Absender (Interessenten) gesendet wird.
• Die Signatur im letzten Abschnitt/Tab wird sowohl an die Admin-Mails, als auch an die Eingangsbestätigungen angehangen.

Mail-Empfänger der Lead-Benachrichtigungen
Beim Eingang neuer Leads werden die entsprechenden Daten – neben der Speicherung in der WordPress-Datenbank – auch in Form einer Benachrichtigungsmail per Voreinstellung an die Haupt-Mailadresse (für administrative Zwecke) der Website gesendet. Sollen die Mails stattdessen an einen oder mehrere alternative Empfänger gesendet werden, können die entsprechenden Adressen hier (kommagetrennt) hinterlegt werden.

Betreff und Nachrichteninhalt
Benachrichtigungen und Eingangsbestätigungen werden als reine Text-Mails versendet. In den Eingabefeldern für den Betreff sowie den Inhalt der jeweiligen Nachrichtenart können diverse Variablen (Platzhalter für die vom Interessenten erfassten Daten etc.) verwendet werden, die im Kopfbereich des Tabs aufgelistet und beschrieben sind.

Die Standard-Mail-Vorlagen, die nach der Plugin-Installation in den Inhaltsfeldern hinterlegt sind, enthalten bereits eine gängige, praxisbezogene Zusammenstellung von Inhalten und Variablen. Eine Ausnahme bilden hier die Platzhalter [is24_basic_valuation] und [pricehubble_valuation] für die Einbindung von Wertermittlungsdaten (ImmobilienScout24-API bzw. PriceHubble-API) in Eingangs-Bestätigungsmails an Interessenten: Diese müssen manuell ergänzt werden, sofern diese Daten der anfragenden Person direkt zur Verfügung gestellt werden sollen. Bewertungsdaten sind (sofern ermittelbar) ansonsten nur „intern“ in den Benachrichtigungsmails an Administratoren sowie in den Formularen der jeweiligen Leads im WP-Backend unter Immobilien-Leads enthalten.

OpenImmo-Feedback-Typ
Bei den Lead-Benachrichtigungen für Administrationsbenutzer werden (optional) Objekt- und Kontaktdaten zusätzlich in Form eines Anhangs im Format OpenImmo-Feedback-XML übermittelt. Diese können bspw. von einer Maklersoftware mit entsprechender Unterstützung automatisiert weiterverarbeitet werden. Sollten hier keine regulären Mail-Anhänge verarbeitet werden können, kann der XML-Quelltext auch direkt an den eigentlichen Nachrichteninhalt angehangen werden.

Tab „Google Maps“

Das Plugin nutzt die Google Maps JavaScript API sowie die Google Places API für die Auto-Vervollständigung von Standortdaten etc. Für die reguläre Nutzung dieser Dienste muss nachfolgend ein individueller API-Schlüssel (hier anfordern) hinterlegt werden.

WICHTIG! Bitte zur Aktivierung des Places API Web Service für den hier genutzten API-Schlüssel auch den Anweisungen im Absatz „Erste Schritte“ von Googles Autocomplete-Infoseite folgen, andernfalls wird die Adress-Autovervollständigung womöglich nicht funktionieren. (Ein hervorragendes Tutorial zur Erstellung eines API-Keys dieser Art ist auch im kulturbanause Blog verfügbar.)

ACHTUNG! Wird kein API Key eingetragen oder verfügt dieser nicht über die passenden Freigaben, wird in den Frontend-Lead-Formularen anstatt der kartenbasierten Standortauswahl ein Eingabeformular für die Objektadresse angezeigt.

Zudem sollten die für die Karte der Standortauswahl verwendeten Standard-Längen- und Breitengrade angegeben werden. Das können bspw. die Koordinaten des Zentrum des eigenen Einsatzbereichs oder des Maklerbüros sein. (Ermittelt werden können diese bspw. via Nominatim oder einen vergleichbaren Dienst.)

Die Einbindung der Google Maps API kann hier auch deaktiviert werden, sofern die Google Maps API inkl. der Places-Library anderweitig eingebunden wird (bspw. vom Theme oder einem anderen Plugin).

Datenschutz-Hinweis
Ab Version 1.6.0 des Lead-Generator-Plugins werden die Google-Kartendienste aus Datenschutzgründen erst nach dem Klick auf einen Bestätigungsbutton durch den Nutzer geladen und aktiviert. Ein entsprechender Infotext inkl. Verlinkung der Google-Datenschutzerklärung, der im Frontend oberhalb dieses Buttons angezeigt wird, kann in diesem Eingabefeld hinterlegt werden.

Tab „Wertermittlung“

ImmobilienScout24 und PriceHubble bieten API-basierte Bewertungs-Dienste an, mit denen automatisiert und in Echtzeit eine „Vorab-Wertermittlung″ bei eingehenden Anfragen zu Wohnhäusern und Wohnungen vorgenommen werden kann. Hierbei wird anhand der wichtigsten Eckdaten (Objektart, Größe, Baujahr, Standort…) und entsprechenden Referenzpreisen aus unterschiedlichen Quellen eine Wertspanne ermittelt, die der ersten Einschätzung eines möglicherweise zu erzielenden Verkaufspreises dient.

Wertermittlung mit ImmobilienScout24

Folgende Bewertungsdienste der IS24-API werden unterstützt:

• Valuation Plus + Reference Price
• Basic Valuation

Bei der erstgenannten Kombination fließen einige Kriterien mehr in die Auswertung ein, die Ergebnisse können also etwas genauer sein als bei der Basis-Variante. Ist einer dieser API-Services nicht verfügbar, wird automatisch der jeweils andere Dienst als Fallback-Lösung verwendet. (Der primäre Wertermittlungs-Dienst kann über die gleichnamige Option festgelegt werden.)

Wie bereits in den vorangegangenen Abschnitten erwähnt, können die ermittelten Werte sowohl in die vom Plugin generierten E-Mails als auch in einer Bestätigungsseite eingebunden werden, die nach dem Absenden der Immobilien- und Kontaktdaten durch die Interessentin/den Interessenten angezeigt wird. Darüber hinaus sind die Daten auch in den Anzeige/Bearbeitungs-Formularen der jeweiligen Leads verfügbar und können hier bei Bedarf anhand aktualisierter Angaben zum Objekt neu berechnet werden (siehe Abschnitt „Lead Daten″).

Voraussetzungen für den Zugriff auf die API sind ein IS24-Benutzerkonto sowie passende Zugangsdaten (Infos zur Anforderung). Hierfür können weitere Kosten anfallen.

Bei der Anforderung des API-Zugangs sollten folgende Angaben übermittelt werden:

Projekt-/Produktname: immonexLeadGeneratorIhrName
URL: Adresse der Website
Programmiersprache: PHP
Anwendungsfall/Berechtigungen: Content Partner
Kategorie / Beschreibung: Internetauftritt mit eigenen Objekten / selbst gehostetes Lead-Generator-Plugin
Ich möchte Zugriff auf: Sandbox und Produktion

Der anschließend angezeigte bzw. per Mail übermittelte API-Key sowie das zugehörige Secret müssen in die entsprechenden Felder der Plugin-Optionen übertragen werden. Neben den API-Zugangsdaten können hier auch die Inhalte der folgenden Vorlagen bearbeitet werden:

Klartext-Template (E-Mails)
Hierbei handelt es sich um die Inhalte, die mit der Variable [is24_basic_valuation] in E-Mails eingefügt werden können (reiner Text ohne Formatierungen). Im Regelfall geht es hier um die Eingangs-Bestätigungsmails, die automatisch an anfragende Interessenten gesendet werden. (Für Lead-Benachrichtigungen, die nur an den Betreiber bzw. Administrator der Website gesendet werden, ist mit [is24_basic_valuation_raw] eine einfachere Variante vorgesehen, die nur die eigentlichen Werte ohne unnötige Rahmentexte etc. enthält.)

Alternativtext (E-Mails)
Sind für einen bestimmten Immobilientyp oder -standort keine Bewertungsdaten abrufbar, werden in den Eingangsbestätigungsmails an Interessenten keine Inhalte anstelle des Platzhalters [is24_basic_valuation] eingefügt. Soll stattdessen ein entsprechender Infotext ergänzt werden, kann dieser in diesem Eingabefeld hinterlegt werden. (Beispiel: „Eine Wertermittlung für diese Immobilienart am angegebenen Standort ist leider nicht möglich.”)

HTML-Template
Die HTML-Vorlage ist für die Einbindung der Wertermittlungsdaten in Bestätigungsseiten vorgesehen, wenn im Feld Weiterleitungs-Seite/URL im Tab „Allgemein″ eine Seiten-ID hinterlegt ist. Auf dieser Seite muss der Shortcode…

[immonex-lead-gen-tag name="is24_basic_valuation_html"]

…hinterlegt werden, damit die Ergebnisse (sofern ermittelbar) hier direkt im Anschluss an das Absenden des Lead-Formulars angezeigt werden.

Soll ein Alternativtext angezeigt werden, wenn kein Preisrahmen ermittelt werden konnte, kann dieser entweder per Shortcode-Attribut alternative oder im nachfolgenden Optionsfeld angegeben werden:

[immonex-lead-gen-tag name="is24_basic_valuation_html" alternative="Für die ausgewählte Objektart konnte keine Wertermittlung durchgeführt werden."]

Sowohl im Klartext- als auch im HTML-Template können wiederum verschiedene Variablen (Platzhalter) verwendet werden, die unterhalb des Klartext-Templates aufgelistet sind.

HTML-Alternativtext
Analog zum Alternativtext für E-Mails kann auch für die Eingangsbestätigungsseiten ein (formatierter) Inhalt erstellt werden, der bei Nichtverfügbarkeit von Bewertungsdaten anstelle dieser eingebunden wird. Wurde ein solcher Text bereits mit dem o. g. Shortcode-Attribut alternative definiert, hat diese Angabe Priorität gegenüber der Angabe im Optionsfeld.

Wertermittlung mit PriceHubble

Das Plugin unterstützt den Bewertungsdienst Valuation Light der PriceHubble-API. Voraussetzung für die Nutzung ist ein entsprechender Vertrag mit dem Anbieter. Mitglieder von Branchenverbänden können hier von Sonderkonditionen profitieren (unverbindlich anfragen).

Die Vorgaben bzgl. Inhalten und Einbindung der Klartext- und HTML-Templates (inkl. Alternativtexten) sind in der PriceHubble-Konfiguration weitestgehend identisch mit der Vorlagen für die IS24-Daten, nur die Bezeichnungen in den zugehörigen Shortcodes bzw. Mail-Variablen (Platzhaltern) sind unterschiedlich:

[pricehubble_valuation] für die Verwendung in E-Mail-Templates

[immonex-lead-gen-tag name="pricehubble_valuation_html"] als Shortcode für die direkte Ausgabe der Bewertungsdaten, wenn eine Weiterleitungs-Seite/URL festgelegt wurde (Tab „Allgemein″)

Auch bei der PriceHubble-Variante kann ein optionaler Alternativtext per Shortcode-Attribut alternative oder im Feld HTML-Alternativtext angegeben werden:

[immonex-lead-gen-tag name="pricehubble_valuation_html" alternative="Für die ausgewählte Objektart konnte keine Wertermittlung durchgeführt werden."]

Bewertungsdaten im Lead-Formular (Frontend)

Ist in einem Frontend-Formular für die Abfrage der Daten eines Hauses oder einer Wohnung ein Eingabefeld mit der Bezeichnung „Wunschpreis″ (bzw. „Desired Price″ in der englischsprachigen Variante) in einer Formularseite enthalten, die nach der Abfrage des Immobilienstandorts angezeigt wird, wird – bei aktiviertem und verfügbarem Bewertungsdienst – automatisch ein Vorgabewert hinterlegt, der sich an der Wertermittlung via IS24- respektive PriceHubble-API orientiert. Voraussetzung ist natürlich, dass für die gewählte Objektart/Standort-Kombination eine Preisspanne ermittelt werden kann.

Diese Option ist standardmäßig aktiviert, kann aber im Untertab „Allgemein” der Wertermittlungs-Konfiguration deaktiviert werden.

Tab „Lizenz“

Lizenzschlüssel und Lizenzstatus
Entwicklung endet nie. Deswegen ist eine gültige und aktive Lizenz Voraussetzung für den automatisierten Bezug von Plugin-Aktualisierungen sowie die Inanspruchnahme des Supports. Der zugehörige Lizenzschlüssel wird beim Kauf übermittelt ist für eine WordPress-Installation gültig (auch Multisite!).

Die Lizenz kann in den Plugin-Einstellungen aktiviert oder deaktiviert werden (bspw. wenn der Lizenzschlüssel für eine andere Installation verwendet werden soll). Die jeweils aktive Website-URL für die Lizenz kann alternativ auch im zugehörigen PluginShop-Benutzerkonto festgelegt werden.

Einbindung

Der Lead-Generator kann mit dem Shortcode [immonex-lead-generator] in beliebigen Seiten, Beiträgen oder Theme-Templates eingebunden werden. Wird dieser Shortcode nicht im Haupt-Inhaltsbereich einer Seite bzw. einer Seite hinterlegt, muss deren ID in den Plugin-Optionen angegeben werden („Aktivieren auf Extra-Seiten″, siehe oben).

Werden neben der Haupt-Formularkonfiguration auch alternative Formularsets (siehe gleichnamige Option oben) eingebunden, kann die jeweilige ID (laufende Nummer) mit dem Shortcode-Attribut form_set_id folgendermaßen angegeben werden:[immonex-lead-generator form_set_id=1]

Fast Forward

Die Einstiegsseite des Lead-Generators im Website-Frontend enthält – neben einem kurzen Einleitungstext – standardmäßig die Auswahl des zu bewertenden Immobilientyps. Soll stattdessen direkt zum Formular einer bestimmten Objektart „gesprungen“ werden, ist fast-forward das passende Shortcode-Attribut hierfür: [immonex-lead-generator fast-forward=1]

Der Attributwert steht hier für die ID des Formulars, in der Standardkonfiguration: 0 = Grundstück, 1 = Haus, 2 = Wohnung, 3 = Gewerbeobjekt.

Als Alternative zum Shortcode-Attribut kann die Fast-Forward-ID auch per GET-Parameter immonex-lead-gen-fast-forward übergeben werden: https://domain.tld/immobilienbewertung/?immonex-lead-gen-fast-forward=1

Lead-Daten

Die Objekt- und Kontaktdaten der an einer Wertermittlung ihrer Immobilien interessierten Verkäufer können unter Immobilien-Leads direkt im WordPress-Backend eingesehen werden, hierfür wird pluginseitig eine eigene Beitragsart eingebunden. Zudem erfolgt bei jedem Eingang eines neuen Kontakts eine Benachrichtigung per E-Mail sowie der Versand einer Eingangsbestätigung an den Absender (sofern aktiviert).

In der Listenansicht können per Klick auf den Lead-Titel bzw. den Bearbeiten-Link darunter die jeweiligen Details angezeigt und bei Bedarf auch bearbeitet bzw. um eigene Anmerkungen ergänzt werden. Auch eine Neuberechnung der per IS24- oder PriceHubble-API ermittelten Preisspannen kann hier angestoßen werden (nur für Wohnhäuser und Wohnungen an Standorten, für die eine Wertermittlung möglich ist).

Formulare

Herzstück des Lead Generators im WordPress-Backend ist der Formulareditor, mit dem ganz einfach individuelle Formulare für die schnelle Beschreibung verschiedener Immobilienarten „per Klick” erstellt werden können.

Nach dem Aufruf des Editors über Immobilien-Leads > Formulare wird zunächst unterschieden zwischen einigen allgemeinen Texten für die Einstiegsseite (Immobilientyp-Auswahl) und die Kontaktdaten-/Absenden-Seiten sowie den eigentlichen Formularen.

Bei letzteren gilt grundsätzlich: Pro Objekttyp wird jeweils ein separates Formular angelegt, wobei die Anzahl der möglichen Objekttypen/Formulare nicht begrenzt ist. Jedes dieser Objektformulare kann wiederum aus beliebig vielen Elementen (Formularseiten) bestehen. Die Reihenfolge der Formulare sowie der zugehörigen Elemente kann per Drag’n’Drop jederzeit angepasst werden. Formulare können darüber hinaus einzeln aktiviert bzw. deaktiviert werden.

In der Standardkonfiguration des Plugins sind vier Objektformulare für Grundstücke, Häuser, Wohnungen und Gewerbeobjekte mit einer gängigen Kombination von Merkmalen (Elemente) standardmäßig verfügbar. Hier sprechen wir von einem „Formularset„.

Kommen mehrere dieser Formularsets zum Einsatz (Option „Alternative Formularsets„, s. o.) werden diese jeweils über eine eigene Konfigurationsseite eingerichtet: Formulare (1), Formulare (2) etc.

Icons

Die Auswahl von Symbolen (Icons) ist im Formulargenerator recht häufig anzutreffen und nimmt dabei eine relativ große Fläche in Anspruch. Aus diesem Grund können die zur Verfügung stehenden Icons immer per Klick auf die entsprechenden Buttons ein- und ausgeblendet werden.

Optik und Umfang der Icon-Auswahl hängt vom Frontend-Theme ab, das in den allgemeinen Einstellungen der Plugin-Optionen ausgewählt wurde.

Formularelemente

Zu jedem Objektformular können beliebig viele Elemente (Seiten) der nachfolgend aufgeführten Typen hinzugefügt werden. Um die mitunter recht umfangreichen Formulare übersichtlich zu halten, können die Konfigurationsabschnitte der Elemente per Klick auf den jeweiligen Titel auf- und zugeklappt werden.

Bei allen Elementen sind die folgenden Standardoptionen in der Konfiguration enhalten:

• Interne Feldbezeichnung
  Die Bezeichnung wird bei der Ausgabe der zugehörigen Werte bzw. Auswahl im Lead-Formular (nur WP-Backend) sowie in den Benachrichtigungs- (Admin) und Eingangs-Bestätigungsmails (Interessent) verwendet.
• Formularelement-Titel
  Im Gegensatz zur Überschrift wird der dieser Titel für die Auflistung der Schritte im Fußbereich der Formularseite (Frontend) verwendet (sofern der Displaybereich, in dem sich das Lead-Generator-Element befindet, breit genug ist).
• Überschrift
  Bei der Überschrift (Titel der Formularseite im Frontend) sowie dem folgenden Einleitungstext können bei Bedarf auch HTML-Tags verwendet werden.
• Einleitungstext
  Diese Angabe ist optional.

Die weiteren Optionen hängen vom Typ des Elements ab:

Auswahlkarten

Getreu der Maxime „so einfach wie möglich” sind „Auswahlkarten” der Elementtyp, der in den Objektformularen normalerweise am häufigsten zum Einsatz kommt: Die Auswahl besteht hier im einfachsten Fall nämlich nur aus einem einzigen Klick auf eine einzelne Option („Karte“). Diese Karten bestehen lediglich aus dem Auswahlbegriff und (optional) einem passenden Icon.

In der Elementkonfiguration kann ausgewählt werden, ob es sich um eine Einzel- oder Mehrfachauswahl handelt. Zudem kann festgelegt werden, ob mindestens eine Option ausgewählt sein muss, bevor zur nächsten Formularseite gewechselt werden kann.

Bei einem Einzelauswahl-Element erfolgt der Wechsel zur nächsten Seite beim Klick auf eine Optionskarte automatisch.

Bei einer möglichen Mehrfachauswahl kann es mitunter vorkommen, dass bestimmte Optionen sich gegenseitig ausschließen (z. B. „Einbauküche neu“ und „Einbauküche gebraucht“). In diesen Fällen kann mit einer Gruppierung dieser Optionen beim Klick auf eine Karte die automatische Abwahl aller anderen Optionen der gleichen Gruppe (= identische Bezeichnung im Eingabefeld „Gruppe“) realisiert werden.

Wertebereich-Slider

Bei dieser Elementart kann mittels eines Schiebereglers (oder alternativ per manueller Eingabe) ein Zahlenwert angegeben werden, der innerhalb eines vorgegebenen Rahmens liegt. Das bietet sich vor allem bei Angaben wie Flächen, Zimmeranzahl oder auch dem Baujahr an.

Da bei Jahresangaben im Regelfall die aktuelle Jahreszahl den Maximalwert darstellt, kann hierfür im betr. Feld die Angabe current_year hinterlegt werden.

Auch bei diesem Element ist die Zuordnung eines Icons möglich.

Dropdown-Auswahlbox

Geht es um umfangreichere Auswahloptionen ohne Schnickschnack wie Icons etc., bietet sich eine Dropdown-Auswahlbox an. Hierüber kann eine Option aus einer Liste beliebiger Vorgaben ausgewählt werden.

Einzelnes Eingabefeld

So unspektakulär, dass wir uns hierfür sogar die Screenshots sparen können: Mit diesem Element kann den Verkaufsinteressenten eine Formularseite mit einem einzelnen ein- oder mehrzeiligen Eingabefeld für beliebige Werte angeboten werden.

Flexible Eingaben/Auswahl

Zugunsten der Flexibilität weichen wir ausnahmsweise vom Grundprinzip „eine Eingabe/Auswahl pro Formularseite″ ab: Dieses Element ermöglicht es, eine beliebige Kombination unterschiedlicher Text-Eingabefelder (ein- oder mehrzeilig) und Auswahlelemente (Dropdown-Auswahlbox, Radio-Elemente, Jahresauswahl…) in einer Formularseite zusammenzufassen.

Die Vorgehensweise zur Erstellung und Bearbeitung der Unterelemente (Eingabe- und Auswahlfelder der Formularseite) entspricht weitestgehend der der übergeordneten Formularelemente.

Standort-Auswahl/Eingabe

ACHTUNG! Das Element „Standortauswahl (Google Map)“ wurde mit der Version 1.8.0 durch diese neue Variante ersetzt und sollte daher nicht mehr verwendet werden!

Pflicht bei jedem Objektformular ist natürlich die Angabe respektive Auswahl des Standorts. Um diese möglichst bequem zu gestalten, bringt das Plugin ein passendes Element mit: Hiermit kann entweder die bewährte Kombination aus Google Map nebst zugehöriger Adress-Autovervollständigung (Autocomplete) oder alternativ ein einfaches Eingabeformular für die Erfassung der Objektadresse eingefügt werden.

Wird das Adressformular als Typ ausgewählt, kann optional eine Länderliste in der Element-Konfiguration hinterlegt werden. Sind hier mindestens zwei Ländernamen enthalten, wird eine entsprechende Auswahlliste im Frontend-Formular angezeigt.

Als Karten-Mittelpunkt werden die im Google-Maps-Tab der Plugin-Optionen angegebenen Koordinaten übernommen. (Hier muss ein individueller Google-API-Key hinterlegt sein!)

Kontaktdatenformular

Ebenso obligatorisch wie die Standortauswahl ist auch die (jeweils letzte) Formularseite, auf der der Interessent seine Kontaktdaten sowie weitere Anmerkungen eingeben und letztendlich – nach Bestätigung der Nutzungsbedingungen – die Bewertung seiner Immobilie anfordern kann.

Optional können hier auch Infos zum Ansprechpartner auf Seiten des Maklerbüros inkl. Foto (aus der Mediathek oder per URL) mit aufgenommen werden.

Wurde im gleichnamigen Options-Tab ein Wertermittlungs-Dienst aktiviert, kann im Kontaktformular – ebenfalls optional – die Auswahl der Wertermittlungsart eingeblendet werden: Interessenten können so vor dem Absenden Ihrer Anfrage auswählen, ob eine einfache „Basis-Bewertung” oder eine erweiterte „Experten-Wertermittlung” gewünscht ist. Die Basis-Bewertung entspricht im Normalfall der via IS24- oder PriceHubble-API ermittelten Preisspanne. (Konnte diese automatisiert abgerufen und übermittelt werden, sind zunächst keine manuellen Bearbeitungsschritte oder eine direkte Kontaktaufnahme mit dem Absender notwendig.)

Eine erweiterte Wertermittlung hingegen sollte neben einer persönlichen Beratung auch die Besichtigung der Immobilie sowie die Berücksichtigung diverser weiterer Faktoren beinhalten, die die Kalkulation eines realistischen Marktpreises beeinflussen. Das Ergebnis wird hierbei in Form einer detaillierten Auswertung inkl. der entsprechenden Berechnungsgrundlagen in einem Dokument zusammengefasst.

ACHTUNG! Die Auswahl der Wertermittlungsart ist in der Kontaktdaten-Formularseite nur dann sichtbar, wenn gleichzeitig auch mindestens ein Wertermittlungs-Dienst (IS24 oder PriceHubble) aktiv ist.

Beschreibung und Bezeichnungen der einfachen und erweiterten Wertermittlung können in der Konfiguration der Kontaktdaten-Elemente (jeweils individuell pro Objektart) im Formulareditor angepasst werden.

Lead-Datensätze, bei denen eine erweiterte Wertermittlung gewünscht ist, werden in der Übersichtsliste im Backend (→ Immobilien-Leads) mit (!) am Anfang des Titels markiert.

Soll die ausgewählte Wertermittlungsart auch in den Eingangsbestätigungs- und Admin-Benachrichtigungsmails aufgeführt werden, muss in den jeweiligen Templates (Tab E-Mail) der folgende Platzhalter eingefügt werden, sofern die Plugin-Version bei der Erstinstallation kleiner als 2.2.0 war: [Erweiterte Bewertung gewünscht+:extended_valuation]

Allgemeine Texte für Kontaktdaten-Elemente (formularübergreifend)

Wir erinnern uns (hoffentlich): Nutzungsbedingungen, Einwilligungstexte, Erfolgsmeldung sowie die Standardvorgabe für die Anmerkungen aller Kontaktformulare können im ersten Abschnitt des Formulargenerators festgelegt werden.

Speichern, Import & Export

Wurden die gewünschten Ergänzungen und Anpassungen der Formularkonfiguration vorgenommen, empfiehlt sich in jedem Fall ein abschließender Klick auf Aktualisieren, damit die Arbeit nicht umsonst war ;-).

Darüber hinaus ist es auch möglich, die komplette aktuelle Konfiguration in einer Datei zu speichern und herunterzuladen (Aktuelle Formulardaten exportieren) oder durch eine zuvor gesicherte Variante zu ersetzen (Formulardaten importieren). Auch das Zurücksetzen des aktuellen Formularsets auf die aktuelle Standardkonfiguration ist per Klick möglich.

Bitte bei mehrsprachigen Installationen beachten: Es werden nur die Daten der aktuellen Hauptsprache exportiert, nicht die Übersetzungen. (Mehr hierzu im folgenden Abschnitt.)

Übersetzung

Der immonex Lead Generator ist für den Einsatz in mehrsprachigen Immobilien-Websites geeignet.

Interne Plugin-Texte übersetzen mit Gettext

Die grundlegenden, plugin-internen Textfragmente werden – im Sinne einer WordPress-konformen und „updatesicheren“ Übersetzung – bereits als po/pot/mo-Dateien mitgeliefert. Grundsprache und damit Basis für weitere Übersetzungen ist hierbei Englisch, wobei die deutschen Übersetzungen natürlich ebenfalls enthalten sind. (Achtung! An diesem Punkt geht es noch nicht um die Übersetzung der Formularinhalte, die erst im folgenden Abschnitt beschrieben wird…)

Soll die deutsche Variante dieser Angaben so angepasst werden, dass diese auch nach einem Update des Plugins erhalten bleibt, ist hierfür zunächst die Datei immonex-lead-generator-de_DE.po aus dem Plugin-Sprachordner (…/wp-content/plugins/immonex-lead-generator/languages) in den globalen WordPress-Ordner für Plugin-Übersetzungen zu kopieren: …/wp-content/languages/plugins

Die Anpassungen können mit einer Plugin-Lösung wie Loco Translate oder einer Desktop-Applikation wie Poedit vorgenommen werden. Nach der Bearbeitung müssen sich im o. g. Ordner neben der Quelldatei (po) auch eine oder mehrere kompilierte Versionen hiervon befinden (mo), die in den meisten Fällen beim Speichern automatisch erstellt werden. Je nach Website-Sprache bzw. Land kann sich der Dateiname von dem der Quelldatei unterscheiden und bspw. auf de_DE_formal.mo (formelle Sie-Variante der deutschen Übersetzungen) oder de_AT.mo (Österreich) bzw. de_CH.mo (Schweiz) enden.

Soll eine neue Sprachvariante angelegt werden, dient hierfür die – ebenfalls im Languages-Ordner des Plugin-Verzeichnisses enthaltene – aktuelle pot-Datei (immonex-lead-generator.pot) als Grundlage.

Formularinhalte übersetzen mit Polylang oder WPML

Wesentlich interessanter als die Plugin-Backend-Texte ist natürlich die Übersetzung der Frontend-Formularinhalte, die der Website-Besucher sieht. Dies kann mit einer den beiden bewährtesten Lösungen für das Übersetzungsmanagement in WordPress realisiert werden: WPML oder Polylang

Eine Besonderheit hierbei ist, dass die mit dem Formulargenerator in der Website-Hauptsprache erfassten Texte nicht nach dem Umschalten der Backend-Sprache ebenfalls hier übersetzt werden, sondern mit dem jeweiligen Modul für die Übersetzung von Zeichenketten (Bezeichnung bei WPML: String-Übersetzung bzw. String Translation).

Auszuwählen ist hier jeweils die Domain admin_texts_immonex-lead-generator_options. (Aus technischen Gründen werden hier teilweise auch reine Zahlenwerte sowie Dateinamen mit aufgelistet, diese können natürlich ignoriert werden.)

Mehrsprachige Standard-Formulare

Die Standard-Formularkonfiguration des immonex Lead Generators, die im Rahmen der erstmaligen Plugin-Installation automatisch eingebunden wird, ist in zwei Sprachen verfügbar: Deutsch und Englisch. Dementsprechend wird bei einer deutschsprachigen WordPress-Installation die DE-Variante, ansonsten die englische Version installiert.

Wird die Hauptsprache der Website nachträglich geändert oder sollen die ursprünglichen Formularinhalte in einer bestimmten Sprache wiederhergestellt werden, kann die entsprechende Datei aus dem Plugin-Ordner (…/wp-content/plugins/immonex-lead-generator) bzw. dem Plugin-ZIP-Archiv via Immobilien-Leads > Formulargenerator neu importiert werden:

Deutsche Version: immonex_lead_gen_default_form_config_en.json
Englische Version: immonex_lead_gen_default_form_config_en.json

Individuelle Anpassungen

Neben der reinen Optik (CSS, Icons) können auch die Vorlagen aller Formularelemente individuell angepasst werden. Auch das Hinzufügen eigener Elemente ist möglich.

CSS per Customizer

Die einfachste Form der optischen Anpassung ist das Überschreiben der betr. Klassenattribute im Theme-Customizer (Design > Customizer > Zusätzliches CSS). Sollen bspw. die Überschriften der Lead-Generator-Formularseiten dunkelblau und fett dargestellt werden, könnte der CSS-Code im Customizer folgendermaßen aussehen:

Anpassungen im Child-Theme

Weitergehende oder umfangreichere Änderungen bzw. Erweiterungen werden über das Child-Theme realisiert. Hier wird zunächst ein Unterordner namens immonex-lead-generator angelegt, über den die Inhalte des Ordners templates im Plugin-Verzeichnis überschrieben oder erweitert werden können.

Auch hier ist das System einfach: Ist eine gleichnamige Datei im o. g. Ordner des Child-Theme-Verzeichnisses vorhanden, wird diese anstatt der Originaldatei im Vorlagenordner des Plugins (templates) verwendet. (Unterordnerstrukturen werden hierbei berücksichtigt.)

Anpassung und Ergänzung von Formularelementen

Hier zunächst eine etwas erweiterte, technische Definition des bereits mehrfach genannten Begriffs „Formularlement”: Hierbei handelt es sich um die Vorlage (Konfiguration + Layout) einer Seite, die in den objekttyp-bezogenen Formularen des Lead Generators im Website-Frontend für die Abfragen der Immobiliendaten durch die Benutzer verwendet wird.

Soll nun also ein vorhandenes Formularelement (z. B. „Auswahlkarten”) angepasst werden, wird hierfür zunächst eine Kopie der entsprechenden Datei aus dem o. g. Plugin-Template-Ordner im Child-Theme-Unterordner immonex-lead-generator angelegt. Die Namen der Elementdateien beginnen generell mit „element_”, der Dateiname des Auswahlkarten-Templates lautet folglich element_card_select.php.

Die Element-Template-Dateien (purer PHP/HTML-Code) sind immer folgendermaßen strukturiert:

• Array $info
  Titel (Name) des Elements sowie (optional) Angaben zu Pflichtfeldern etc.
• Array $config
  Hier werden die Felder der Elementkonfiguration im Formulargenerator definiert (jeweils Feldname ⇒ Unterarray mit Feldparametern). Der obligatorische Feld-Parameter „scope” kann hier entweder den Wert „admin” (nur für das Backend relevant, keine Übersetzung nötig) oder „frontend” (später per Formulargenerator erfasster Wert wird im Frontend angezeigt und soll übersetzbar sein).
• PHP/HTML-Code für die Ausgabe der Formularseite inkl. der im Formulargenerator angegebenen Werte für die per $config-Array definierten Felder

Die Vorlagen neuer bzw. komplett eigenständiger Formularelemente werden ebenfalls im genannten Child-Theme-Ordner hinterlegt. Diesen muss lediglich ein individueller Dateiname sowie ein eindeutiger Name (title) im $info-Array zugewiesen werden. (Es bietet sich an, als Vorlage für eigene Elemente die Template-Datei eines vorhandenen Formularelements zu verwenden.)

Eigene Elemente können anschließend genau wie die mitgelieferten im Formulargenerator ausgewählt und konfiguriert werden.

Frontend-Themes

Ein Frontend-Theme ist im Wesentlichen ein Set von Icons sowie eine CSS-Datei, die über die allgemeinen Plugin-Optionen einen schnellen Wechsel der Formularoptik ermöglichen.

Auch hier können die Dateien der mitgelieferten Themes im Child-Theme überschrieben werden. Soll bspw. eine Variante des Standardthemes „Heeba” (Original-Ordnername: default) mit individuell angepassten CSS-Angaben (aber unveränderten Icons) zum Einsatz kommen, wird hierfür eine Datei namens style.css im Child-Theme-Template-Ordner immonex-lead-generator/themes/default angelegt.

Die Frontend-Theme-CSS-Dateien beginnen immer mit dem Theme-Namen. Beispiel:

Im Themes-Unterordner des o. g. Child-Theme-Template-Verzeichnisses können selbstverständlich auch eigene Frontend-Themes für den Lead Generator ergänzt werden. In diesem Fall werden allerdings keine Icons übernommen, d. h. entweder muss ein eigenes Iconset (PNG-Dateien) im Unterordner icons hinterlegt oder ein gleichnamiger Ordner eines mitgelieferten Themes hierher kopiert werden.

E-Mail-Vorlagen

Seit Version 1.4 des Lead Generators können die Inhalte der Benachrichtigungs- und Eingangsbestätigungsmails direkt in der Plugin-Konfigurationsseite des WP-Backends bearbeitet werden. Es gibt hier nur eine Ausnahme: Ist der Eingabebereich für den Inhalt der Admin-Benachrichtigung leer, kommt eine Template-Datei zum Einsatz, die bei Bedarf im Unterordner mail des Child-Theme-Template-Verzeichnisses überschrieben bzw. individuell angepasst werden kann.

JavaScript-Events

Bei der Nutzung der Lead-Formulare im Frontend werden eine Reihe von JavaScript-Events emittiert, die für eigene Erweiterungen genutzt werden können (bpsw. die Anbindung von Analytik/Tracking-Systemen). Jedes Event enthält ein Detail-Attribut, das die die zugehörigen Meta-Daten in Form von Werten oder Funktionsreferenzen für den Abruf enthält.

immonexLeadGen:primaryPropertyTypeSelection_viewed

Anzeige der primären Immobilientyp-Auswahl (direkt nach dem Laden des Lead Generators in der Einstiegsseite)

Meta-Daten (detail)

• formSetID (ID des Formularsets, Standard: 0)

Beispielfunktion

immonexLeadGen:propertyTypeForm_selected

Auswahl eines Immobilientyp-Formulars

Meta-Daten (detail)

• formSetID (ID des Formularsets, Standard: 0)
• propertyTypeID (ID des Immobilientyps bzw. Formulars)
• formTitle (Titel des Formulars/Bezeichnung des Immobilientyps)

Beispielfunktion

immonexLeadGen:propertyTypeForm_navigated

Navigation innerhalb eines Immobilientyp-Formulars (Wechsel zwischen Formularelementen/-seiten)

Meta-Daten (detail)

Achtung! Bei den folgenden Angaben handelt es sich um Funktionsreferenzen – abschließende Klammern nicht vergessen!

• formSetID() (ID des Formularsets, Standard: 0)
• propertyTypeID() (ID des Immobilientyps bzw. Formulars)
• formTitle() (Titel des Formulars/Bezeichnung des Immobilientyps)
• elementID() (ID/Seitennummer des Formularelements, zu dem navigiert wurde)
• elementTitle() (Titel des Formularelements, zu dem navigiert wurde)

Beispielfunktion

immonexLeadGen:propertyTypeForm_submitted

Übermittlung nach Absenden der per Immobilientyp-Formular erfassten Daten

Meta-Daten (detail)

Achtung! Bei den folgenden Angaben handelt es sich um Funktionsreferenzen – abschließende Klammern nicht vergessen!

• formSetID() (ID des Formularsets, Standard: 0)
• propertyTypeID() (ID des Immobilientyps bzw. Formulars)
• formTitle() (Titel des Formulars/Bezeichnung des Immobilientyps)
• status() (Übermittlungsstatus: success bei erfolgreicher Übermittlung der Anfrage, error bei Fehler)

Beispielfunktion

Filter-Referenz

immonex_lead_gen_notification_recipients

Mailadressen von Empfängern der Lead-Benachrichtigungen/Eingangsbestätigungen anpassen

Parameter

• [string] Mailadressen als kommagetrennte Liste
• [string] Kontext (admin bei Administrator-Benachrichtigungen, prospect bei Eingangsbestätigungsmails an Interessenten)

immonex_lead_gen_notification_headers

Mail-Header der Lead-Benachrichtigungen/Eingangsbestätigungen anpassen

Parameter

• [Array (string)] Headerzeilen
• [string] Kontext (admin bei Administrator-Benachrichtigungen, prospect bei Eingangsbestätigungsmails an Interessenten)

immonex_lead_gen_notification_subject

Betreff der Lead-Benachrichtigungen/Eingangsbestätigungen anpassen

Parameter

• [string] Mail-Betreff
• [string] Kontext (admin bei Administrator-Benachrichtigungen, prospect bei Eingangsbestätigungsmails an Interessenten)

immonex_lead_gen_notification_body

Nachrichtentext der Lead-Benachrichtigungen/Eingangsbestätigungen anpassen

Parameter

• [string] Nachrichtentext
• [string] Kontext (admin bei Administrator-Benachrichtigungen, prospect bei Eingangsbestätigungsmails an Interessenten)

immonex_lead_gen_oi_feedback_xml

XML-Quelltext des OpenImmo-Feedback-Anhangs (Admin-Benachrichtigungsmails) anpassen

Parameter

• [string] XML-Quelltext