Lodgix Plugin Shortcodes

Shortcode options for use with the Lodgix plugin.

Brent Kleinheksel avatar
Written by Brent Kleinheksel
Updated over a week ago

[property]

Purpose: Displays a single property

Accepted attributes:

*note any attribute added to this shortcode will override what has been set in the within the plugin settings. By default there should be no need to use a shortcode. However, shortcodes can help customize individual properties or place property info on other pages.

Attribute

Purpose

Default

Example

id

Determines the property to display by WordPress post id

This is set by default when the shortcode is placed on a property post. If the shortcode is used elsewhere you will need to add this for it to work. You can do this by going to Properties, clicking on the property you want to display, and copying this portion from the URL /wp-admin/post.php?post=27&action=edit

[property id=27]

ldx_id

Determines the property to display by Lodgix property ID

By default this is determined automatically by the WordPress post ID

[property ldx_id=1]

layout

Determines which property layout is used.

This is set by the "Property Layout" setting under the Property Detail tab.

This will use the full width layout
[property layout="ldx_full_layout"]

slider

Displays the photo slider

This is set by the “Image Slider” setting under the Property Detail tab.

This will show the slider

[property slider=true]

This will hide the slider

[property slider=false]

alt_view

Determines if the full header layout should be used

This is set by the "Full Header Slider" setting under the Property Detail tab

This will display the full slider header.

[property alt_view=true]

slider_captions

Displays photo captions on the slider

This is set by the “Image Slider Captions” setting under the Property Detail tab.

This will show the captions

[property slider_captions=true]

This will hide the captions

[property slider_captions=false]

full_page_slider

Determines if the property slider can be opened into a full screen view when clicked.

This is set by the "Full Page Images" setting under the Property Detail tab.

[property full_page_slider=true] will enable the full page images

[property full_page_slider=true] will disable the full page images

full_width_sections

Determines if property content sections are display with title sidebar

This is set by the "Full Width Content Sections" setting under the Property Detail tab.

[property full_width_sections=false] will display section titles to the side

[property full_width_sections=true] will display section titles on top of content

details

Determines if the property details section is displayed

This is set by the “Details” setting under the Property Detail tab.

This will display the property details section

[property details=true]

This will hide the property details section

[property details=false]

accomodations

Determines if the property sleeping arrangements section is displayed

This is set by the “Sleeping Arrangements” setting under the Property Detail tab.

This will display the property sleeping arrangements section

[property accomodations=true]

This will hide the property sleeping arrangements section

[property accomodations=false]

amenities

Determines if the property amenities section is displayed

This is set by the "Amenities" setting under the Property Detail tab.

This will show the amenities section [property amenities=true]

This will hide the amenities section [property amenities=true]

availability

Determines if the property calendar section is displayed

This is set by the “Availability” setting under the Property Detail tab.

This will display the property availability calendar section

[property availability=true]

This will hide the property availability calendar section

[property availability=false]

rates

Determines if the property rates are displayed in the side bar

This is set by the “rates” setting under the Property Detail tab.

This will display the property rates

[property rates=true]

This will hide the property rates

[property rates=false]

location

Determines if the property location section is displayed

This is set by the “Location (map)” setting under the Property Detail tab.

This will display the property location section

[property location=true]

This will hide the property location section

[property location=false]

display_address

Determines if the address is displayed within the location section. If the location section is hidden, this setting is ignored

This is set by the “Display Address” setting under the Property Detail tab.

This will display the property address

[property display_address=true]

This will hide the property address

[property display_address=false]

policies

Determines if the policies section is shown

This is set by the “Policies” setting under the Property Detail tab.

This will display the property policies section

[property policies=true]

This will hide the property policies section

[property policies=true]

reviews

Determines if the reviews section is shown

This is set by the “reviews” setting under the Property Detail tab.

This will display the property reviews section

[property reviews=true]

This will hide the property reviews section

[property reviews=true]

related

Determines if the related properties section should be shown.

This is set by the “Related Properties” setting under the Property Detail tab.

This will display the related property section

[property related=true]

This will hide the related property section

[property related=true]

sticky_side

Determines if the sidebar is "sticky" on the page when a user is scrolling

This is set by the "Sticky Sidebar" setting under the Property Detail tab.

This will enable the property sticky sidebar

[property sticky_side=true]

This will disable the property sticky sidebar

[property sticky_side=true]

stay-info

Determines if the stay information section in the sidebar is displayed

This is set by the “Stay Information” setting under the Property Detail tab.

This will display the stay information section

[property stay-info=true]

This will hide the stay information section

[property stay-info=true]

social-share

Determines if the social media icons in the sidebar is displayed

This is set by the “Social Share” setting under the Property Detail tab.

This will display the social icons

[property social-share=true]

This will hide the social icons

[property social-share=false]

displaySSFB

Determines if facebook share icon is shown in property sidebar

This is set under the “Social Share” settings under the Property Detail tab.

This will display the facebook icon

[property displaySSFB=true]

This will hide the facebook icon

[property displaySSFB=false]

displaySSTwt

Determines if twitter share icon is shown in property sidebar

This is set under the “Social Share” settings under the Property Detail tab.

This will display the twitter icon

[property displaySSTwt=true]

This will hide the twitter icon

[property displaySSTwt=false]

displaySSEm

Determines if email share icon is shown in property sidebar

This is set under the “Social Share” settings under the Property Detail tab.

This will display the email icon

[property displaySSEm=true]

This will hide the email icon

[property displaySSEm=false]

displaySSSL

Determines if share link icon is shown in property sidebar

This is set under the “Social Share” settings under the Property Detail tab.

This will display the share link icon

[property displaySSSL=true]

This will hide the share link icon

[property displaySSSL=false]

displaySSIP

Determines if print icon is shown in property sidebar

This is set under the “Social Share” settings under the Property Detail tab.

This will display the print icon

[property displaySSIP=true]

This will hide the print icon

[property displaySSIP=false]

[lodgix_search]

Purpose: Displays the property search form

Attribute

Purpose

Default

Example

id

Determines the forms element id.

Randomly generated.

[lodgix_search id="my_unique_id"]

arrival

Determines if the arrival and departure date fields are displayed.

true

This will hide the arrival field
[lodgix_search arrival=false]

location

Determines if the location field is displayed.

true

This will hide the location field
[lodgix_search location=false]

bedrooms

Determines if the bedrooms field is displayed.

true

This will hide the bedrooms field
[lodgix_search bedrooms=false]

guests

Determines if the guests field is displayed.

true

This will hide the guests field
[lodgix_search guests=false]

price

Determines if the price fields are displayed.

true

This will hide the price fields
[lodgix_search price=false]

pets

Determines if the pets field is displayed.

false

This will show the pets field [lodgix_search pets=true]

tags

Determines if the tags field is displayed.

false

This will show the tags field [lodgix_search tags=true]

categories

Determines if the categories field is displayed.

false

This will show the categories field [lodgix_search categories=true]

amenities

Determines if the amenities field is displayed

false

This will show the amenities field [lodgix_search amenities=true]

name

Determines if the search by name or id field is displayed.

false

This will show the name/id field [lodgix_search name=true]

arrival_label

Determines the arrival field label.

Set by the Arrival Form Label setting under the Search Bar tab.

[lodgix_search arrival_lable="Arrive"]

departure_label

Determines the departure field label.

Set by the Departure Form Label setting under the Search Bar tab.

[lodgix_search departure_lable="Depart"]

location_label

Determines the loation field label.

Set by the Locations Form Label setting under the Search Bar tab.

[lodgix_search location_label="Location"]

bedrooms_label

Determines the bedrooms field label.

Set by the Bedrooms Form Label setting under the Search Bar tab.

[lodgix_search bedrooms_label="Bedrooms"]

guests_label

Determines the guests field label.

Set by the Guests Form Label setting under the Search Bar tab.

[lodgix_search guests_label="Guests"]

from_price_label

Determines the from price field label.

Set by the From Price Form Label setting under the Search Bar tab.

[lodgix_search from_price_label="From Price"]

to_price_label

Determines the to price field label.

Set by the To Price Form Label setting under the Search Bar tab.

[lodgix_search to_price_label="To Price"]

from_price

Determines the starting price value.

Set by the From Price setting under the Search Bar tab.

[lodgix_search from_price="50"]

to_price

Determines the top price value.

Set by the To Price setting under the Search Bar tab.

[lodgix_search to_price="1000"]

price_increment

Determines the pricing increment.

Set by the Price Increment setting under the Search Bar tab.

[lodgix_search price_increment="50"]

currency_symbol

Determines the pricing field currency symbol.

Set by the Currency Symbol setting under the Search Bar tab.

[lodgix_search currency_symbol="$"]

pet_friendly_label

Determines the pet friendly field label.

Set by the Pet Friendly Form Label setting under the Search Bar tab.

[lodgix_search pet_friendly_label="Pet Friendly"]

categories_label

Determines the categories field label.

Set by the Categories Form Label setting under the Search Bar tab.

[lodgix_search categories_label="Categories"]

tags_label

Determines the tags field label.

Set by the Tags Form Label setting under the Search Bar tab.

[lodgix_search tags_label="Tags"]

search_label

Determines the search by name or id field label.

Set by the Listing Name / ID Form Label setting under the Search Bar tab.

[lodgix_search search_label="Listing Name / ID"]

button_text

Determines the submit button text,

Search

[lodgix_search button_text="Search"]

styled_layout

Determines if a prestyled layout should be used. This options can override the other styling options.

Accepts three options, 1, 2, 3.

[lodgix_search styled_layout="3"]

horizontal

Determines if the form should be displayed horizontally, or vertically.

true

[lodgix_search horizontal=false]

horizontal_columns

Determines the amount of columns a horizontal form should have on desktop.

3

[lodgix_search horizontal_columns="2"]

horizontal_alignment

Determines the column alignment of a horizontal form.

center

Accepts three options, left, center, right.

[lodgix_search horizontal_alignment="left"]

formbgc

Sets the background color of the form.

[lodgix_search formbgc="#ffffff"]

field_color

Sets the field text color of the form.

#000000

[lodgix_search field_color="#000000"]

field_active_color

Sets the active field text color of the form.

#000000

[lodgix_search field_active_color="#000000"]

field_background

Sets the field background color of the form.

#ffffff

[lodgix_search field_background="#ffffff"]

button_background

Sets the submit button background color of the form.

Set by the primary colors setting under the styles tab.

[lodgix_search button_background="#0d47a1"]

button_text_color

Sets the submit button text color of the form.

#ffffff

[lodgix_search button_text_color="#ffffff"]

field_radius

Sets the border radius of all form elements in px.

5

[lodgix_search field_radius="0"]

[lodgix_featured]

Purpose: Displays the feature properties grid

Attribute

Purpose

Default

Example

layout

Determines if the grid is aligned to the left, center, or right

left

[lodgix_featured layout=”center”]

count

Determines the number of properties to display

3

[lodgix_featured count=”3”]

columns

Determines the number of columns to display

3

[lodgix_featured columns=”3”]

rotate

Determines if properties are shown at random order

false

[lodgix_featured rotate=false]

show_all

Determines if any property can be shown, or only those marked as featured

false

Displays properties marked as featured

[lodgix_featured show_all=false]

Displays any property

[lodgix_featured show_all=false]

property_type

Determines if the property type text is shown

true

[lodgix_featured property_type=true]

[lodgix_featured property_type=false]

bathrooms

Determines if the number of bathrooms is shown

true

[lodgix_featured bathrooms=true]

[lodgix_featured bathrooms=false]

location

Determines if the property location is shown

true

Display location

[lodgix_featured location=true]

Hides location

[lodgix_featured location=false]

guests

Determines if the number of guests are shown

true

Displays guests

[lodgix_featured guests=true]

Hides guests

[lodgix_featured guests=false]

bedrooms

Determines if the number of beds is shown

true

Displays beds

[lodgix_featured bedrooms=true]

Hides beds

[lodgix_featured bedrooms=false]

pets

Determines if pet friendly info is shown

true

Displays pets

[lodgix_featured pets=true]

Hides pets

[lodgix_featured pets=false]

price

Determines if price is shown

true

Displays price

[lodgix_featured price=true]

Hides price

[lodgix_featured price=false]

prop_cats

Determines if properties from specific property categories are displayed. The Wordpress property category id must be used.

[lodgix_featured prop_cats="1,2,3"]

prop_tags

Determines if properties from specific property tags are displayed. The Wordpress property category id must be used.

[lodgix_featured prop_tags="2"]

prop_ids

Determines the properties to be shown by WordPress post ID

[lodgix_featured prop_ids="1,2,3"]

[lodgix_availability]

Purpose: Displays lodgix availability calendar

Attribute

Purpose

Default

Example

wpsiteid

Limits properties shown in availability tape to specific site

Default will be set to the current site ID

[lodgix_availability wpsiteid="2"]

[lodgix_name]

Purpose: Displays the property manager company name, or falls back to the site title if one isn’t present

Default display: Used in the inquiry confirmation message

Accepted attributes: none

[lodgix_inquiry]

Purpose: Displays the inquiry form

Attribute

Purpose

Default

Example

use_nonce

Adds a nonce to the search form for added protection. Sites that are heavily cached will need to reduce the caching level on their inquiry page to use this feature

false

This will add a nonce security field to the inquiry form.

[lodgix_inquiry use_nonce=true]

property_id

Sets a property as the default value on form load.

This will set a property with the id of 1 as the default selected property.

[lodgix_inquiry property_id="1"]

[lodgix_categories]

Purpose: Displays the property categories and or tags in a grid.

Attribute

Purpose

Default

Example

show_categories

Determines if property categories are shown

true

This will hide the categories
[lodgix_categories show_categories=false]

show_tags

Determines if property tags are shown.

false

This will show the tags
[lodgix_categories show_tags=true]

term_ids

Determines which property categories or tags are shown by ID. This overrides the show_categories and show_tags settings.

This will display terms with the ids, 1, 2, & 3
[lodgix_categories term_ids="1,2,3"]

show_count

Determines if the number of properties in the term should be displayed.

true

This will hide the property count
[lodgix_categories show_count=false]

show_description

Determines if the term description should be displayed.

true

This will hide the term description
[lodgix_categories show_description=false]

columns

Determines the number of grid columns.

3

[lodgix_categories columns="1"]

col_alignment

Determines the alignment of the columns. Accepts, align-right, align-center, align-left.

align-left

Center aligns the columns.

[lodgix_categories col_alignment="align-center"]

text_alignment

Determines the text alignment of the columns. Accepts, right, center, left.

left

Center aligns the text.
[lodgix_categories text_alignment="center"]

[lodgix_reviews]

Purpose: Display a grid or slider of property reviews

Attribute

Purpose

Default

Example

layout

Determines if reviews are displayed in a "grid", or "slider" layout.

grid

This will display reviews in a slider
[lodgix_reviews layout="slider"]

slider_autoplay

Determins if a slider autoplays, or has to be manually rotated by the user

false

This will autoplay the review slider [lodgix_reviews slider_autoplay=true]

text_align

Determines the text alignment of the reviews. Accepts text-left, text-center, text-right

text-left

[lodgix_reviews text_align="text-center"]

columns

Determines the number of columns to display when the grid layout is in use.

2

[lodgix_reviews columns="3"]

star_min

Determines the minimum number of stars a review requires to be displayed.

5

This will show 4 and 5 star reviews.
[lodgix_reviews star_min="4"]

max_count

Determines the maximum number of reviews to display

4

Will show up to ten reviews.
[lodgix_reviews max_count="10"]

random

By default, reviews are pulled from properties by the order properties are displayed. This determines if that order should be random.

false

This will randomize the reviews display order.

[lodgix_reviews random=true]

single_property

This determines if only one review should be displayed per property.

true

This will allow multiple reviews from a single property.
[lodgix_reviews single_property=false]

show_property_title

Determines if the property title the review is attributed to should be displayed.

true

This will hide the property title.
[lodgix_reviews show_property_title=false]

show_image

Determines if the property image the review is attributed to should be displayed.

false

This will hide the property image.
[lodgix_reviews show_image=false]

show_stars

Determines if the review starts should be displayed.

true

This will hide the review stars [lodgix_reviews show_stars=false]

show_byline

Determines if the review author's name should be displayed

true

This will hide the review author's name [lodgix_reviews show_byline=false]

show_review_date

Determines if the review date should be displayed

true

This will hide the review date [lodgix_reviews show_review_date=false]

word_count

Determines the word count limit applied to the review

This will limit the review word count to 55 words. [lodgix_reviews word_count=55]

[ldx_cred_link]

Purpose: Used to display a link to Lodgix

Accepted Attributes: none

Did this answer your question?