Shortcodes

WP ImmoSync bevat verschillende shortcodes voor meerdere doeleinden. In deze documentatie vindt u de details en het gebruik van elke shortcode.

Index

Gutenberg-blokken
Pandgegevens en eigenschappen
Formulieren

Gutenberg-blokken

De volgende shortcodes zijn ook beschikbaar als Gutenberg-blokken in de insertercategorie ImmoSync. Shortcodes blijven ondersteund (PHP-thema’s, Grid Builder, Classic editor).

Blok	Shortcode	Opmerkingen
ImmoSync Form	`[wpis-form-contact]`, `[wpis-form-estate]`, `[wpis-form-evaluation]`	Eén blok. Kies het formuliertype in de zijbalk.
ImmoSync Details list	`[wpis-details-list]`	Vereist een pand-/projectpostcontext (eigenschapseditor, Query Loop of singlesjabloon).
ImmoSync Value	`[wpis-value]`	Idem: gebruikt het huidige pand wanneer het sjabloon wordt bekeken.
ImmoSync Label	`[wpis-label]`	Dezelfde postcontext als Value.

[wpis-group] en [wpis-estate-listing] blijven alleen als shortcode beschikbaar.

De posttypes pand, project en agent zijn beschikbaar in de WordPress REST API zodat ze in Gutenberg bewerkt kunnen worden. Aangepaste wpis_*-postmeta is niet geregistreerd in REST; de HTML van blokken wordt op de server gerenderd.

Pandgegevens en eigenschappen

[wpis-details-list]

Deze shortcode genereert een lijst van pandlabels en -waarden, gegroepeerd per collectie. De shortcode bevat vooraf gedefinieerde collecties en kan een lijst maken met uw wpis-eigenschappen.

De vertaling van labels en eenheden gebeurt automatisch op basis van de huidige WordPress-taal (beschikbare talen: EN, FR, NL)

De gegenereerde code heeft een standaardklasse zodat u elk element naar wens kunt stylen.

Voorbeeld

<ul class="wpis-detail-list collection-energy">
  <li>
    <span class="label label-energy_epcValue">Mesure énergétique</span>
    <span class="value value-energy_epcValue"
      >339
      <span class="unit"> kWh/m²/an</span>
    </span>
  </li>
  <li>
    <span class="label label-energy_gazEmit">Emission de gaz</span>
    <span class="value value-energy_gazEmit"
      >339
      <span class="unit"> Kg/CO2/an</span>
    </span>
  </li>
</ul>

Parameters :

collection

Definieert de te gebruiken collectie
Optioneel ALLEEN als de parameter properties wordt gebruikt
Beschikbare collectie : general, energy, configuration

exlude :

Stel uit te sluiten eigenschappen in, gescheiden door een “,”
Optioneel

properties :

Definieert welke eigenschap te gebruiken, gescheiden door een “,”
Optioneel

Gebruik :

Voorbeeld 1

Eenvoudig gebruik van een collectie

[wpis-details-list collection="general" /]

// Geeft de lijst van eigenschappen uit de collectie `general` terug

Voorbeeld 2

Uitsluiting van sommige eigenschappen uit een bestaande collectie

[wpis-details-list collection="general" exclude="finance_price, address_city" /]

// Geeft de lijst van eigenschappen uit de collectie `general` terug zonder de uitgesloten eigenschappen

Voorbeeld 3

Aanmaken van een aangepaste lijst op basis van gekozen meta’s

[wpis-details-list metas="id, finance_price, energy_epcLabel" /]

// Geeft een aangepaste lijst terug op basis van de gedefinieerde meta's

[wpis-label]

Deze shortcode geeft een label terug van een gegeven wpis-metadata.

De vertaling gebeurt automatisch op basis van de huidige WordPress-taal (beschikbare talen: EN, FR, NL)

Parameters :

wrap

Laat u inhoud definiëren die het label omwikkelt.
De parameter %s wordt automatisch vervangen door het label.
De parameter %s is verplicht als de parameter wrap wordt gebruikt.
Optioneel

Gebruik :

Voorbeeld 1

Basisgebruik

[wpis-label meta="finance_price" /]

// Geeft het label `Price` terug

Voorbeeld 2

Gebruik met de wrap-parameter

[wpis-label meta="finance_price" wrap="<span class='my-label-price'>%s</span>" /]

// Geeft het label <span class="my-label-price">Price</span> terug

Voorbeeld 3

Gebruik met inhoudsomwikkeling

[wpis-label meta="finance_price"]<span class="my-label-price">%s</span>[/wpis-label]

// Geeft het label <span class="my-label-price">Price</span> terug

[wpis-value]

Deze shortcode geeft een waarde terug van een gegeven wpis-metadata. De waarde wordt vooraf opgemaakt teruggegeven, met een eenheid wanneer de gegevens dat vereisen.

Parameters :

meta

Wordt gebruikt om te bepalen welke wpis-meta-eigenschap terug te geven
Geaccepteerde waarden zijn elke wpis-eigenschap die in de plugin beschikbaar is
Verplicht

format

Kan worden gebruikt om meta-opmaak uit te schakelen of een vooraf gedefinieerd filter in te stellen
Geaccepteerde parameters: true, false, capitalize, decimal, number, price, yes/no
Standaard: true
Optioneel

unit

Kan worden gebruikt om de vooraf gedefinieerde eenheid te verbergen
Geaccepteerde parameter : true of false
Standaard : true
Optioneel

wrap

Laat u inhoud definiëren die het label omwikkelt.
De parameter %s wordt automatisch vervangen door het label.
De parameter %s is verplicht als de parameter wrap wordt gebruikt.
Optioneel

Gebruik :

Voorbeeld 1

Basisgebruik

[wpis-value meta="areas_total" /]

// Geeft `85,00 m²` terug

Voorbeeld 2

Opmaak uitschakelen

[wpis-value meta="areas_total" format="false"/]

// Geeft `85 m²` terug

Voorbeeld 3

Opmaak uitschakelen

[wpis-value meta="areas_total" format="false"/]

// Geeft `85 m²` terug

Voorbeeld 4

Opmaak overschrijven en eenheid uitschakelen

[wpis-value meta="areas_total" format="price" unit="false" /]
85 €
// Geeft `85 €` terug

Voorbeeld 5

Opmaak en eenheid uitschakelen

[wpis-value meta="areas_total" format="false" unit="false" /]
// Geeft `85` terug

Voorbeeld 6

Gebruik met de wrap-parameter

[wpis-value meta="areas_total" format="false" unit="false wrap="It's %s meters squared"/]
// Geeft `It's 85 meters squared` terug

Voorbeeld 7

Gebruik met inhoudsomwikkeling

[wpis-value meta="areas_total" format="false" unit="false"]It's %s meters squared[/wpis-value]
// Geeft `It's 85 meters squared` terug

[wpis-group]

Deze shortcode geeft meerdere waarden terug van een gedefinieerde set wpis-metadata, gescheiden door een spatie of een aangepast scheidingsteken. De waarde wordt vooraf opgemaakt teruggegeven, met een eenheid wanneer de gegevens dat vereisen.

Parameters :

metas

Wordt gebruikt om een set wpis-meta-eigenschappen terug te geven, gescheiden door een “,”
Geaccepteerde waarden zijn elke wpis-eigenschap die in de plugin beschikbaar is
Verplicht

separator

Wordt gebruikt om het scheidingsteken tussen waarden te definiëren
Standaard: “``”
Optioneel

skip-zero

Wordt gebruikt om waarden gelijk aan nul over te slaan
Geaccepteerde parameters: true, false
Standaard: false
Optioneel

format

Kan worden gebruikt om meta-opmaak uit te schakelen
Geaccepteerde parameters: true, false
Standaard: true
Optioneel

unit

Kan worden gebruikt om de vooraf gedefinieerde eenheid te verbergen
Geaccepteerde parameter : true of false
Standaard : true
Optioneel

wrap

Laat u inhoud definiëren die het label omwikkelt.
De parameter %s wordt automatisch vervangen door het label.
De parameter %s is verplicht als de parameter wrap wordt gebruikt.
Optioneel

Gebruik :

Voorbeeld 1

Meerdere waarden met een aangepast scheidingsteken

[wpis-group metas="areas_bedroom1, areas_bedroom2, areas_bedroom3, areas_bedroom4, areas_bedroom5" separator=" - "]
// Geeft `14,00 m² - 11,00 m² - 4,00 m² - -` terug

Voorbeeld 2

Meerdere waarden met een aangepast scheidingsteken, zonder opmaak en met overslaan van nulwaarden

[wpis-group metas="areas_bedroom1, areas_bedroom2, areas_bedroom3, areas_bedroom4, areas_bedroom5" separator=", " format="false" unit="true" skip-zero="true"/]
// Geeft `14 m², 11 m², 4 m²` terug

Voorbeeld 3

Meerdere waarden met een aangepast scheidingsteken, zonder opmaak, met overslaan van nulwaarden en wrap-parameter

[wpis-group metas="areas_bedroom1, areas_bedroom2, areas_bedroom3, areas_bedroom4, areas_bedroom5" separator=", " format="false" unit="true" skip-zero="true" wrap="Surface Chambres : %s"/]
// Geeft `Surface Chambres : 14 m², 11 m², 4 m²` terug

Voorbeeld 4

Meerdere waarden met een aangepast scheidingsteken en inhoudsomwikkeling

[wpis-group metas="address_longitude, address_latitude" separator="; "]<div class="geo">%s</div>%s…[wpis-group]
// Geeft `<div class="geo">4.419409; 50.81194</div>` terug

Formulieren

De HTML van formulieren, e-mails en wpis-forms.js kunnen vanuit het actieve thema worden overschreven. Zie Theme templates.

JavaScript-events

Wanneer een bezoeker een ImmoSync-formulier indient, verzendt de plugin twee bubbling CustomEvents op het <form>-element. Thema’s kunnen op document luisteren zonder wpis-forms.js te kopiëren.

Beide events maken de ingediende formuliervelden beschikbaar in event.detail. Beveiligingsvelden (_wpis_token, website) worden weggelaten. event.target is het formulierelement.

Event	Wanneer het wordt afgevuurd
`wpis_form_submission`	Zodra het formulier wordt ingediend, vóórdat het verzoek wordt verzonden
`wpis_form_success`	Nadat de server de indiening heeft aanvaard

event.detail bevat:

formId — id van het formulierelement (wpis-form-contact-default, wpis-form-contact-extended, wpis-form-evaluation, of wpis-form-estate)
source — contactForm, evaluationForm, of estateForm
url — pagina-URL op het moment van indienen
gender, firstname, lastname, email, phone, message
addressStreet, addressNumber, addressBox, addressZip, addressCity op uitgebreide contact- en evaluatieformulieren
listId wanneer een contactlijst is ingesteld
estateId, postId op het pandformulier

Gebruik in het thema

Enqueue een klein script vanuit het actieve thema (of child-thema). De listener kan op document worden geregistreerd op elk moment vóór indienen:

add_action('wp_enqueue_scripts', function () {
    wp_enqueue_script(
        'mytheme-immosync-forms',
        get_stylesheet_directory_uri() . '/js/immosync-forms.js',
        [],
        wp_get_theme()->get('Version'),
        true
    );
});

document.addEventListener('wpis_form_submission', function (event) {
    var data = event.detail;

    // Voorbeeld: Google Tag Manager / analytics
    window.dataLayer = window.dataLayer || [];
    window.dataLayer.push({
        event: 'wpis_form_submission',
        formId: data.formId,
        source: data.source,
        email: data.email,
    });
});

document.addEventListener('wpis_form_success', function (event) {
    var data = event.detail;

    window.dataLayer = window.dataLayer || [];
    window.dataLayer.push({
        event: 'wpis_form_success',
        formId: data.formId,
        source: data.source,
        email: data.email,
        estateId: data.estateId,
    });
});

U kunt bij succes ook aangepaste themalogica uitvoeren (omleiding, extra bevestiging, CRM-pixel, enzovoort):

document.addEventListener('wpis_form_success', function (event) {
    var data = event.detail;

    if (data.source === 'estateForm') {
        console.log('Lead for estate', data.estateId, data);
    }
});

[wpis-form-contact]

Deze shortcode genereert een formulier voor contactdoeleinden. Het contact wordt gesynchroniseerd met Wordpress en via ImmoSync naar de vastgoedsoftware verzonden.

Parameters :

type

Wordt gebruikt om te bepalen of het formulier standaard of uitgebreid moet zijn. Uitgebreid voegt enkele extra formuliervelden toe met betrekking tot het adres
Geaccepteerde parameters: default, extended
Standaard: default
Optioneel

style

Wordt gebruikt om de standaardstijl van het formulier in of uit te schakelen
Geaccepteerde parameters: on, off
Standaard: on
Optioneel

submit

Wordt gebruikt om de standaardtekst van de verzendknop te overschrijven
Geaccepteerde waarde: sting
Standaard: Send
Optioneel

list-id

Wordt gebruikt om een contactlijst-ID te injecteren.
Geaccepteerde waarde: contactlijst-ID uit Whise-software.
Standaard: -1 (geen contactlijst-ID)
Optioneel

Gebruik :

Voorbeeld 1

Standaard contactformulier

[wpis-contact-form /]

Voorbeeld 2

Uitgebreid contactformulier

[wpis-form-contact type="extended"]

Voorbeeld 3

Uitgebreid contactformulier zonder standaardstijl

[wpis-form-contact type="extended" style="off"]

Voorbeeld 4

Contactformulier met aangepaste verzendtekst

[wpis-form-contact submit="My custom text"]

[wpis-form-evaluation]

Deze shortcode genereert een formulier voor evaluatiedoeleinden. Het contact wordt gesynchroniseerd met Wordpress en via ImmoSync naar de vastgoedsoftware verzonden.

Parameters :

style

Wordt gebruikt om de standaardstijl van het formulier in of uit te schakelen
Geaccepteerde parameters: on, off
Standaard: on
Optioneel

submit

Wordt gebruikt om de standaardtekst van de verzendknop te overschrijven
Geaccepteerde waarde: sting
Standaard: Send
Optioneel

list-id

Wordt gebruikt om een contactlijst-ID te injecteren.
Geaccepteerde waarde: contactlijst-ID uit Whise-software.
Standaard: -1 (geen contactlijst-ID)
Optioneel

Gebruik :

Voorbeeld 1

Eenvoudig evaluatieformulier

[wpis-form-evaluation /]

Voorbeeld 2

Formulier zonder standaardstijl

[wpis-form-evaluation style="off"]

Voorbeeld 3

Evaluatieformulier met aangepaste verzendtekst

[wpis-form-evaluation submit="My custom text"]

[wpis-form-estate]

Deze shortcode genereert een formulier voor interesse in een pand. Het formulier bepaalt de context en verzendt de pand-ID en details per e-mail naar de klant en de ontvanger. Het contact wordt gesynchroniseerd met Wordpress en via ImmoSync naar de vastgoedsoftware verzonden.

Parameters :

style

Wordt gebruikt om de standaardstijl van het formulier in of uit te schakelen
Geaccepteerde parameters: on, off
Standaard: on
Optioneel

submit

Wordt gebruikt om de standaardtekst van de verzendknop te overschrijven
Geaccepteerde waarde: sting
Standaard: Send
Optioneel

estate-id

Wordt gebruikt om een pand-ID te injecteren. Heeft voorrang op de ID die van de huidige pandpagina wordt gedetecteerd.
Geaccepteerde waarde: pand-ID
Standaard: gedetecteerd uit de huidige postmeta wpis_id
Optioneel. Vereist als de shortcode niet op een pandpagina wordt gebruikt.

list-id

Wordt gebruikt om een contactlijst-ID te injecteren.
Geaccepteerde waarde: contactlijst-ID uit Whise-software.
Standaard: -1 (geen contactlijst-ID)
Optioneel

Gebruik :

Voorbeeld 1

Eenvoudig pandformulier

[wpis-form-estate /]

Voorbeeld 2

Pandformulier zonder standaardstijl

[wpis-form-estate style="off"]

Voorbeeld 3

Pandformulier met aangepaste verzendtekst

[wpis-form-estate submit="My custom text"]

Voorbeeld 4

Pandformulier met een expliciete pand-ID (overschrijft de huidige pagina)

[wpis-form-estate estate-id="12345"]