[rep_suburbs]

You can use our Suburbs Shortcode to display suburbs from your Malcolm account directly on any page or post.

Product

Shortcode Attributes

There are a number of shortcode attributes available which you can use to customize the output.

GENERAL LAYOUT

1. display – Defines the display between Grid, and Carousel view.
   • Default: The default value is based on the selected value under Malcolm > Settings > General > General > Display.
   • Options: grid, carousel.
2. layout – Controls the layout of each suburb on the result.
   • Default: The default value is based on the selected value under Malcolm > Settings > General > General > Layout.
   • Options: From 1 to 5. Specify one only.
     • 1 – Image above content
     • 2 – Image left content
     • 3 – Image right content
     • 4 – Image overlay content
     • 5 – Content only
3. columns – Defines how many suburbs are displayed per row. Use in conjunction with layout 1, 4, and 5. This attribute is ignored on layout 2 and 3.
   • Default: The default value is based on the selected value under Malcolm > Settings > General > General > Columns.
   • Options: From 1 to 5. Specify one only.
4. max_chars – Maximum number of characters to display in the suburb description.
   • Default: The default value is based on the selected value under Malcolm > Settings > General > General > Max Characters.
   • Options: Integer values. Recommended value is around 150.
5. max_posts – The maximum number of suburbs to display.
   • Default: The default value is based on the selected value under Malcolm > Settings > General > General > Max Posts.
   • Options: Integer values.

GRID LAYOUT

1. posts_per_page – Toggles pagination on. Use in conjunction with max_posts.
   • Default: The default value is based on the selected value under Malcolm > Settings > General > General > Posts Per Page.
   • Options: Integer values.

CAROUSEL LAYOUT

1. autoplay – Enable or disable carousel autoplay.
   • Default: The default value is based on the selected value under Malcolm > Settings > General > General > Autoplay.
   • Options: on or off.
2. infinite_carousel – Enable or disable infinite carousel, allowing the carousel to slide endlessly
   • Default: The default value is based on the selected value under Malcolm > Settings > General > General > Infinite Carousel.
   • Options: on or off.

SECTION

1. header_title – Displays header title text above the feed.
2. header_sub_title – Displays header sub title text above the feed.
3. section_background_image – Adds a background image to section. Use image URL as value.
4. section_background_color – Adds a background color to the section. Use valid CSS color value.
5. section_font_color – Defines the font color used on the section. Use valid CSS color value.
6. section_width – Defines the width of the section.
   • Default: default (which is a max width of 1140px).
   • Options: default, small, medium, large or full. Specify one only.
7. view_more_link_text – Text to display on the section view more button. This is not applicable when archive is on
   • Default: "View more".
8. view_more_link – URL to view more suburbs.
9. classes – Adds an HTML class to the section wrapper so you can modify the specific output with custom CSS.

FILTER

1. categories – Set the post category.
2. exclude_categories – An array of excluded categories.
3. orderby – Specifies the order in which suburbs are displayed.
   • Default: The default value is based on the selected value under Malcolm > Settings > Suburbs > General > Order By.
   • Options: date, title, menu_order, rand. Specify one only.
4. order – Determines whether the suburbs are listed in ascending or descending order.
   • Default: The default value is based on the selected value under Malcolm > Settings > Settings > General > Order.
   • Options: asc, desc. Specify one only.
5. featured – Filters suburbs based on their “featured” status.
   • Default: off.
   • Options: on or off.

Example Usage

[rep_suburbs orderby="date" order="ASC" categories="suburb-category" posts_per_page="10"]