You can find some general documentation here to get started with WP-ImmoMakler®’s comprehensive options.
If you have more detailed questions, feel free to contact us by email or phone as part of the licensing support. We will help solve your problem and find a solution.
Go to the WordPress admin area to install the WP-ImmoMakler® installation file via “Plugins > Install”. Alternatively, you can upload the unpacked installation file directory “immomakler/” to the FTP server in “/wp-content/plugins/”. You can activate the plugin now. The WordPress Plugin Manager will list available updates and offer to install them automatically.
Create an “/openimmo/“ directory in your WordPress directory to store the files exported from your estate agent software.
Set up a new export interface in your estate agent software. For this purpose, set up FTP access to the server and, if required, the “/openimmo/” directory. Select the most recent OpenImmo version number and “Send as ZIP”, if possible. A customer/vendor number or ID can be selected freely.
Run a “Portal export/sync” from the estate agent software.
You can import the exported files manually under “WP-ImmoMakler® > Property Import” or activate the auto-import function. Once auto-import is activated, the estate agent software will automatically compare the properties, so that you need not log in to WordPress again. WP-ImmoMakler® continuously monitors the directory and imports new export files automatically.
The imported properties can be found under the WordPress admin menu “WP-ImmoMakler® > Properties”.
Visit http://www.your-website/immobilien/ to view the properties. To do so, you must have activated the permalinks (SEO-friendly URLs) under “Settings > Permalinks“.
Select “Design > Menus” and drag, for example, the elements “Buy” and “Rent” from the “Types of Marketing” box to integrate properties into your menu. Create a “Link” element to “/immobilien/” to list all properties.
For further configuration options, see “WP-ImmoMakler® > Settings” and the “WP-ImmoMakler” section in the WordPress Customizer.
WP-ImmoMakler® uses a responsive layout based on Bootstrap 3 by default to present the properties. However, it can also be used without a Bootstrap-based WordPress theme. (A modified, immomakler{} wrapped Bootstrap 3 version is supplied so as not to affect the CSS of the WordPress theme used.)
CSS generally allows you to customize the presentation to your own needs.
WP-ImmoMakler® allows you to amend HTML templates using WordPress Child Themes. For this purpose, WP-ImmoMakler® supplies a so-called child-skin plugin. Once the plugin is installed and activated, the child-skin layout can be selected under “WP-ImmoMakler® > Settings”.
Now you can go to the plugin-directory /wp-content/plugins/immomakler/skins/bootstrap3/ and copy the individual files that you want to customize while keeping the directory structure of the child-skin plugin. For presentation purposes, WP-ImmoMakler® chooses the copy rather than the main skin of the same file name.
Use the copy to make the desired changes. For example, you can reorganize individual data boxes or redistribute double columns. The responsive behavior can also be adjusted by changing the Bootstrap 3 CSS classes.
Exceptions:
/wp-content/themes/your-theme/immomakler/functions.php is loaded prior to the functions.php located in the main skin. Therefore, the functions contained therein can be overwritten (pluggable functions)./wp-content/themes/your-theme/immomakler/css/immomakler.css is loaded additionally after the supplied CSS.
You can provide additional CSS instructions or overwrite existing ones here. Do not copy the entire CSS file. Instead, create an empty immomakler.css and add your own styles only.
Fitting the archive and exposé pages into your custom theme is best done by adding the container <div>s surrounding the content to the /header.php and /footer.php files provided in the child-skin plugin, which then apply to both archive and single views. If you want to distinguish views in them, it is best to use if (is_immomakler_single()){ } else { }.
Alternatively, you can copy, for example, the page.php (or the respective template you want) of the WordPress theme used to archive-immomakler_object.php and single-immomakler_object.php and swap the the_content() or the entire loop for the respective part from the archive- immomakler_object.php or single-immomakler_object.php from WP-ImmoMakler®.
Note for custom theme developers: You can permanently integrate your WP-ImmoMakler® customizations into your theme by copying the files from the child-skin into your theme under wp-content/themes/your-theme/immomakler/.
If you have any questions, feel free to contact us.
We will integrate your theme (i. e. customize it to the theme template as well as layout, color, single column, or multiple columns) for a fixed price as part of our integration service.
We will also assist you with more comprehensive customization to better suit your needs (subject to a charge depending on the amount of work involved).
WP-ImmoMakler® PLUS uses Google Maps API (application programming interface) to show the real estate maps (search results) and the geocoding results (determining the latitude and longitude of a given address or the central point of a zip code area if no street address is publicly available) and for automatic address completion in the vicinity search.
You must have an API key to use the Google Maps services. Google will then let you use them and will invoice you for extensive use.
To use the API keys, you must open a billing account and link it to the API project at https://console.cloud.google.com/project/_/billing/enable.
But don’t worry. Not even customers with over 800 real estate objects and lots of traffic on their website have ever exceeded any of the free-usage limits. Nevertheless, Google requires you to indicate your bank account or credit card number, but as mentioned above, experience has shown that the monthly free-usage quota is not exceeded.
For safety reasons, your API keys should be restricted to ensure that no third party can use your keys at your expense (for example, the JavaScript API key is readable for anybody in the source code of the browser).
The geocoding API is called up from the server (IP address restriction) and the maps and autocomplete are called up from your website visitors’ browser (domain name restriction). An API key can only be restricted to either IP addresses or URLs/domain names, so you need two different API keys.
If you have any questions or need help with setting up the keys, please do not hesitate to contact us.
The following API keys and settings are required:
Instructions: Setting up Google Maps Geocoding API
API key settings: https://console.developers.google.com/apis/credentials
The APIs you need must be enabled under “APIs & Services” > Library”:
– Geocoding API: Enable Geocoding API.
Recommended application restriction:
– IP address (your personal IP address will be displayed in the WP-ImmoMakler® settings; additional development environments are also possible here).
Recommended API restriction:
– Geocoding API.
Instructions: creating an API key for Google Maps JavaScript API.
API key settings: https://console.developers.google.com/apis/credentials
The APIs you need must be enabled under “APIs & Services” > Library”:
– Maps JavaScript API: Enable Maps JavaScript API.
– Places API: Enable Places API.
WP-ImmoMakler® can display reference real estate objects as a separate menu item. The reference object data will be shown automatically in reduced form (only descriptions, images, and location; no prices, areas, etc.).
The presentation can be customized by using your own template if required or requested to meet individual needs (display of references, etc).
Reference objects must be marked accordingly. In most cases, this is done in the estate agent software. As reference properties are not standardized within the OpenImmo standard, several options are available:
onOffice
The “Reference real estate” checkbox is available under the “Marketing” tab in the “Own website” box. You must call the onOffice support (+49 241 44686-122) and have the so-called “marketing fields” activated to ensure that they are transferred to your website. Afterwards, you need not make any additional settings in WP-ImmoMakler®.
Other estate agent software
You have two options here:
Add a new custom field (e.g. the “Reference object” checkbox). Consult your software’s manual or support team, when necessary. The following user-defined fields are accepted by WP-ImmoMakler® already. Additional fields can be added, if required.
immobilie-user_defined_anyfield-Referenz = 1 or 'true'
real-estate-user_defined_anyfield-Referenzobjekt = 'true'
ausstattung-user_defined_anyfield-Referenz = 1 or 'true'
verwaltung_techn-user_defined_anyfield-Referenzobjekt = 'Ja'
Create a new portal interface (e.g. “reference website”) to which you can export your reference real estate objects. These exports must end with the openimmo/references/ directory of the server to be automatically marked as references.
Please contact us if the options described above do not work in your estate agent software or result in additional costs, or if you prefer a different workflow. We will help you find a solution.
After initial import of some reference objects, they will be listed under /immobilien/referenzen/. They are now available in the shortcodes with status=reference (Avada Theme: immobilien-status=reference).
You can assign any WP_Query parameters to the [immomakler-archive], [immomakler-map], [immomakler-carousel] and [immomakler-flexslider] shortcodes to filter the displayed properties.
The columns parameter allows you to define the number of columns for [immomakler-searchagents-form] and [immomakler-archive]. A single-column search form is particularly useful for text-based widgets.
Please see the below section ‘Make custom field (post meta) available for queries’ below in the section “Useful examples of applying filter hooks” for use of special values.
[immomakler-search-form] (common 4-columns layout) [immomakler-search-form columns=1] (vertical 1-column layout as on mobile devices)
[immomakler-search-for-id]
[immomakler-archive] [immomakler-archive vermarktungsart=kauf status=referenz columns=2] [immomakler-archive vermarktungsart=kauf typ=wohnung posts_per_page=3 columns=1] [immomakler-archive nutzungsart=gewerbe posts_per_page=-1 columns=2] [immomakler-archive meta_key=kaufpreis meta_value=1000000 meta_compare='>'] [immomakler-archive meta_key=verwaltung_objekt-user_defined_simplefield-objekt_des_tages meta_value=1 posts_per_page=3 columns=3]
[immomakler-map] [immomakler-map vermarktungsart=kauf] [immomakler-map vermarktungsart=kauf typ=wohnung ort=hamburg]
[immomakler-flexslider] or [immomakler-carousel] [immomakler-flexslider vermarktungsart=kauf] [immomakler-flexslider typ=wohnung] [immomakler-flexslider meta_key=kaufpreis meta_value=1000000 meta_compare='>' posts_per_page=10] [immomakler-flexslider meta_key=verwaltung_objekt-user_defined_simplefield-objekt_des_tages meta_value=1 posts_per_page=10]
This short code must only be applied to search results, e.g. within a sidebar. Creating a search agent requires the global variable $wp_query of an executed WP-ImmoMakler search.
[immomakler-searchagents-form]
[immomakler-searchagents-form-full]
WP-ImmoMakler® is equipped with numerous WordPress Filter and Action Hooks (see below for the full list), which allow you to change the output and import behavior from outside the plugin code.
We have listed some useful filters below. Copy the relevant code examples in the functions.php of your Child Skin plugin under wp-content/plugins/immomakler-child/functions.php and customize them to your needs. At your request we will specify the filters that best meet your needs.
With WP-ImmoMakler® 5.8 and higher, not all real estate values are available as an individual post meta key to improve performance.
The following filters let you create individual post meta fields to make them available for meta queries:
add_filter( 'immomakler_searchable_postmeta_keys', 'custom_immomakler_searchable_postmeta_keys' );
function custom_immomakler_searchable_postmeta_keys( $immomakler_metakeys ) {
$immomakler_metakeys[] ='verwaltung_objekt-user_defined_simplefield-objekt_des_tages';
return$immomakler_metakeys;
}
See below for available taxonomies.
add_filter('immomakler_search_enabled_taxonomies', 'my_immomakler_search_taxonomies');
function my_immomakler_search_taxonomies( $taxomonies ) {
return array(
'immomakler_object_vermarktung',
'immomakler_object_nutzungsart',
'immomakler_object_type',
'immomakler_object_location',
);
}
add_filter('immomakler_search_enabled_ranges', 'my_immomakler_search_ranges');
function my_immomakler_search_ranges( $ranges ) {
return array(
'immomakler_search_size' => array(
'label' => 'Wohnfläche',
'slug' => 'qm',
'unit' => 'm²',
'decimals' => 0,
'meta_key' => 'wohnflaeche',
'slider_step' => 5
),
'immomakler_search_rooms' => array(
'label' => 'Anzahl Zimmer',
'slug' => 'zimmer',
'unit' => '',
'decimals' => 1,
'meta_key' => 'anzahl_zimmer',
'slider_step' => 0.5
),
'immomakler_search_price_rent' => array(
'label' => 'Kaltmiete',
'slug' => 'kaltmiete',
'unit' => '€',
'decimals' => 0,
'meta_key' => 'kaltmiete',
'slider_step' => 100
),
'immomakler_search_price_buy' => array(
'label' => 'Kaufpreis',
'slug' => 'kaufpreis',
'unit' => '€',
'decimals' => 0,
'meta_key' => 'kaufpreis',
'slider_step' => 25000
),
);
}
add_filter('immomakler_default_order', 'custom_immomakler_default_order');
function custom_immomakler_default_order( $im_order ) {
return 'priceasc'; // möglich sind: 'priceasc', 'pricedesc', 'dateasc', 'datedesc'
}
With 'crop' => true, images can be cropped to the stated value. With 'crop' => false, the stated value determines the borders.
add_filter('immomakler_image_sizes', 'custom_immomakler_image_sizes');
function custom_immomakler_image_sizes( $images_sizes ) {
$images_sizes['immomakler-archive-thumb'] = array( 'width' => 350, 'height' => 250, 'crop' => false );
return $images_sizes;
}
Standard sizes are:
array(
'immomakler-gallery-big' => array( 'width' => 900, 'height' => 900, 'crop' => false ),
'immomakler-gallery-thumb' => array( 'width' => 100, 'height' => 60, 'crop' => false ),
'immomakler-archive-thumb' => array( 'width' => 360, 'height' => 390, 'crop' => false ),
'immomakler-archive-thumb-big' => array( 'width' => 475, 'height' => 475, 'crop' => false ),
'immomakler-person-thumb' => array( 'width' => 190, 'height' => 190, 'crop' => false )
)
A real estate object appears at the end of the list by default even after an update (date of the first publication on the website). Use this filter if you want it to appear at the top of the list after an update.
add_filter ('immomakler_preserve_post_date_on_update', '__return_false');
Countries are generated as taxonomy by default and can be listed under URL /immobilien-in/spanien/. You can use the following category for immobilien-in/ausland/. You can define the primary country (not abroad) in the WP backend under ‘WP-ImmoMakler > Settings > Import’.
add_filter ('immomakler_mark_foreign_countries', '__return_true');
add_filter('immomakler_galleria_options', 'immomakler_custom_galleria_options');
function immomakler_custom_galleria_options( $options ) {
$options['transition'] = 'fade';
$options['autoplay'] = '3000';
return $options;
}
add_filter('immomakler_object_terms_types', 'custom_immomakler_object_terms_types', 10, 2);
function custom_immomakler_object_terms_types( $object_types, $openimmo_data ) {
if ( $openimmo_data['gewerbe'] ) {
$object_types[] = 'Gewerbe';
}
if ( $openimmo_data['verwaltung_objekt-user_defined_simplefield-xyz'] == 'PREMIUM' ) {
$object_types[] = 'Premiumimmobilie';
}
return $object_types;
}
add_filter('immomakler_object_terms_nutzungsart', 'custom_immomakler_object_terms_nutzungsart', 10, 2);
function custom_immomakler_object_terms_nutzungsart( $object_nutzungsart, $openimmo_data ) {
if ( $openimmo_data['verwaltung_objekt-user_defined_simplefield-xyz'] == 'PRIVAT' ) {
$object_nutzungsart[] = 'Privat';
}
if ( $openimmo_data['verwaltung_objekt-user_defined_simplefield-xyz'] == 'INSTITUTIONELL' ) {
$object_nutzungsart[] = 'Institutionell';
}
return $object_nutzungsart;
}
The following WordPress taxonomy example ‘immomakler_search_zip_code’ can be integrated, for instance, under ‘selection fields in the search mask’, as explained above, or used within a shortcode: [immomakler-archive vermarktungsart=kauf plz="12345,12355,12347"]
add_action( "init", "custom_immomakler_register_taxonomies" );
function custom_immomakler_register_taxonomies() {
register_taxonomy(
'immomakler_search_plz',
'immomakler_object',
array(
'labels' => array(
'name' => _x('Postleitzahlen', 'taxonomy general name'),
'singular_name' => _x('Postleitzahl', 'taxonomy singular name'),
'all_items' => _x('Alle Postleitzahlen', 'taxonomy choose all'),
),
'rewrite' => array( 'slug' => 'immobilien-plz', 'hierarchical' => false, 'with_front' => false ),
'hierarchical' => false,
'query_var' => 'plz',
'public' => true,
'show_ui' => true
)
);
}
add_action( "immomakler_after_post_create", "custom_immomakler_index", 10, 2 );
function custom_immomakler_index( $post_id, $openimmo_data ) {
if ( ! empty ( $openimmo_data['plz'] ) ) {
wp_set_object_terms( $post_id, $openimmo_data['plz'], 'immomakler_search_plz' );
}
}
Please search the plugin code for the corresponding filter name and for its exact usage, execution location and the available parameters of each filter.
About the use of WordPress Filter Hooks
immomakler_allow_delete_post immomakler_append_anbieternr_to_anid immomakler_append_anbieternr_to_obid immomakler_append_language_to_obid immomakler_archive_on_delete immomakler_archive_title immomakler_attachment_caption immomakler_attachment_data_path immomakler_attachment_description immomakler_attachment_icon_class immomakler_attachment_nodes_before_processing immomakler_attachment_title immomakler_auto_publish_post immomakler_available_taxonomies immomakler_available_themes immomakler_back_to_archive_link immomakler_bebaubar_nach_mapping immomakler_cart_add_to_cart immomakler_cart_archive_title immomakler_cart_archive_title_search immomakler_cart_cookie_lifetime immomakler_cart_searchable immomakler_cart_show_cart immomakler_cart_widget_item immomakler_contact_form_with_posts immomakler_contact_form_without_posts immomakler_contactform_agb immomakler_contactform_cc immomakler_contactform_customer_is_sender immomakler_contactform_enabled_fields immomakler_contactform_mail_no_posts_subject immomakler_contactform_mail_to_email immomakler_contactform_mail_to_name immomakler_contactform_mail_with_posts_subject immomakler_contactform_mailfailed immomakler_contactform_mailsent immomakler_contactform_mandatory_fields immomakler_contactform_message_text immomakler_contactform_submit_value immomakler_contactform_validationfailed immomakler_contactform_widerruf immomakler_contactform_widerruf_in_multiple_request immomakler_country_taxonomy immomakler_currency immomakler_custom_max_execution_time immomakler_default_currency immomakler_default_order immomakler_default_property_image_path_filename immomakler_delete_imported_files_after_days immomakler_disable_frontend immomakler_email_attachments immomakler_enqueue_bootstrap_js immomakler_epass_diagram_size immomakler_erschliessung_mapping immomakler_feature_list_args immomakler_feature_taxonomy immomakler_find_duplicate_by immomakler_galleria_options immomakler_galleria_theme_file immomakler_geocode_address immomakler_geocode_address_if_hidden immomakler_geocode_with_bundesland immomakler_googlemaps_api_key immomakler_hide_address immomakler_home_country_iso immomakler_image_sizes immomakler_immomakler_object_type_add_objektart immomakler_immomakler_object_type_add_objektart_detail immomakler_import_basedir_abspath immomakler_import_dir_abspath immomakler_import_dir_max_depth immomakler_import_notifications_recipient_email immomakler_import_notifications_recipient_name immomakler_import_post_type immomakler_importer_only immomakler_insert_attachment_args immomakler_is_immomakler_archive immomakler_is_immomakler_single immomakler_iso_land_mapping immomakler_language_code immomakler_language_code_default immomakler_link_icon_class immomakler_list_files_sorted_by_field immomakler_location_taxonomy immomakler_log_import_to_file immomakler_map_address_with_bundesland immomakler_map_address_with_sublocality immomakler_mark_as_reference_instead_of_delete immomakler_max_attachments immomakler_number_of_columns_archive immomakler_number_of_columns_single immomakler_nutzungsart_taxonomy immomakler_object_country_slug immomakler_object_feature_slug immomakler_object_location_slug immomakler_object_nutzungsart_slug immomakler_object_status_message immomakler_object_status_slug immomakler_object_terms_country immomakler_object_terms_feature immomakler_object_terms_location immomakler_object_terms_nutzungsart immomakler_object_terms_status immomakler_object_terms_types immomakler_object_terms_vermarktungsart immomakler_object_type_hierarchical immomakler_object_type_slug immomakler_object_vermarktung_slug immomakler_objektart_list_args immomakler_objektart_mapping immomakler_opengraph_facebook_admins immomakler_openimmo_data immomakler_openimmo_data_before_set_post_meta immomakler_openimmofeedback_key_for_oobj_id immomakler_options_defaults immomakler_options_sanitize immomakler_person_post_type immomakler_post_author immomakler_post_title immomakler_post_type_immomakler_object_args immomakler_post_type_immomakler_person_args immomakler_posts_per_page immomakler_preis_zeiteinheit immomakler_preserve_post_date_on_update immomakler_property_subtitle immomakler_property_type_taxonomy immomakler_protect_duplicate_property_posts immomakler_radiussearch_default_radius immomakler_radiussearch_radius_values immomakler_recaptcha_validationfailed immomakler_search_archive_title immomakler_search_button_text immomakler_search_dropdown_show_children immomakler_search_enabled_ranges immomakler_search_enabled_taxonomies immomakler_searchagents_confirmation_flash_message immomakler_searchagents_no_confirm_mail_sent_flash_message immomakler_searchagents_notification_email_body immomakler_searchagents_notification_email_subject immomakler_searchagents_please_confirm_email_subject immomakler_searchagents_please_confirm_flash_message immomakler_searchagents_unsubscribe_flash_message immomakler_seo_permalinks immomakler_settings_tabs immomakler_show_ui_country immomakler_show_ui_feature immomakler_show_ui_location immomakler_show_ui_nutzungsart immomakler_show_ui_status immomakler_show_ui_type immomakler_show_ui_vermarktung immomakler_single_title immomakler_skin_bootstrap3_vertical_archive_layout immomakler_status_taxonomy immomakler_taxomomy_immomakler_object_country_args immomakler_taxomomy_immomakler_object_feature_args immomakler_taxomomy_immomakler_object_location_args immomakler_taxomomy_immomakler_object_nutzungsart_args immomakler_taxomomy_immomakler_object_status_args immomakler_taxomomy_immomakler_object_type_args immomakler_taxomomy_immomakler_object_vermarktung_args immomakler_theme_bootstrap3_vertical_archive_layout immomakler_use_timestamp_for_file_id immomakler_user_defined_fields immomakler_vermarktung_taxonomy immomakler_video_links immomakler_zustand_mapping
Please search the plugin code for the corresponding action name and for its exact usage, execution location and the available parameters of each filter.
About using WordPress Action Hooks
immomakler_after_archive immomakler_after_archive_item immomakler_after_archive_items immomakler_after_archive_no_items immomakler_after_archiving_existing_post immomakler_after_import_filelist immomakler_after_import_zipfile immomakler_after_pagination immomakler_after_post_create immomakler_after_save_attachments immomakler_after_single immomakler_after_single_details immomakler_archive_property_actions immomakler_archive_property_details_bottom immomakler_archive_property_details_top immomakler_before_archive immomakler_before_archive_item immomakler_before_archive_items immomakler_before_archive_items_references immomakler_before_archive_no_items immomakler_before_contactform immomakler_before_delete_post immomakler_before_import_zipfile immomakler_before_publish_post immomakler_before_single immomakler_before_single_details immomakler_before_update_post immomakler_end_epass immomakler_search_form_after_ranges immomakler_search_form_after_taxonomies immomakler_search_form_begin immomakler_search_form_end immomakler_searchagents_after_form immomakler_searchagents_before_form immomakler_single_contact_begin immomakler_single_contact_bottom immomakler_single_description_end immomakler_single_details_before_price immomakler_single_details_begin immomakler_single_details_end immomakler_single_property_actions
The import will fill the following taxonomies (categories) automatically and connect with the respective property. They can be used for search forms, menu items, and custom WP_Query or ‘get_posts()’ requests to categorise the real estate.
immomakler_object_type immomakler_object_country immomakler_object_vermarktung immomakler_object_nutzungsart immomakler_object_location immomakler_object_feature immomakler_object_status