Shortcodes

Shortcodes are a great way to show JReviews content anywhere on your site. In other Joomla components and WordPress plugins, banner custom fields and even in your template customizations.

#Overview

Shortcodes are another way to surface JReviews content on the site, in addition to Joomla modules, WordPress widgets, detail page related listing widgets, and custom embed options.

The modern [jreviews] rendering engine is gated behind the Shortcodes Early Access feature (Configuration → Early Access Settings). When it is off (the default), shortcodes use the legacy renderer and the older behavior. When it is on, they render through the modern engine — modern card layouts, the new layout and override attributes, and per-field Show Title support — and an admin Shortcode Preview page (Control Panel → Shortcode Preview) shows a live gallery of every shortcode type where you can see the output and copy ready-made examples.

The following shortcode types are available at this time:

• Listings Display list of listings
• Reviews Display list of reviews
• Field Display output of a custom field
• Manage Listing Display the manage listing dropdown or links
• Listing Cover Display the listing cover image
• Listing Favorites Display the listing's favorite add/remove button
• Listing MyLists Display the listing's add-to-list button (MyLists add-on)

#Listings Shortcode

The listings shortcode uses the same query and card layouts as the JReviews listings Joomla module and WordPress widget. Below you can find a few examples of how to use it:

Single listing with an alias "westville-east"

[jreviews type="listings" listing_alias="westville-east" summary="1"]

Custom Search Params provide a simple way to filter listings by available search parameters.

All listings that have the keyword "Apple"

[jreviews type="listings" custom_params="keywords=Apple"]

All event listings in the next 7 days

[jreviews type="listings" custom_params="jr_eventdate=+7"]

For multi-option custom fields, the legacy default requires every selected value. Add usematch=1 to make those fields match any selected value. Add matchall[field_name]=1 for an individual field that should keep all-match behavior.

[jreviews type="listings" custom_params="usematch=1&jr_keywords=giraffe_gambling"]

[jreviews type="listings" custom_params="usematch=1&matchall[jr_keywords]=1&jr_keywords=giraffe_gambling"]

10 top rated listings

[jreviews type="listings" listing_order="rating" columns="2" limit="10" show_numbers="1"]

Latest listings filtered by category

[jreviews type="listings" listing_order="rdate" category="23" limit="6"]

Listings in proximity to current listing

When used in the listing detail page, it will auto-detect the current listing's location.

[jreviews type="listings" listing_order="proximity" radius="10" limit="6"]

Listings in proximity to custom coordinates

[jreviews type="listings" listing_order="proximity_custom" radius="50" custom_lat="42.3600825" custom_lon="-71.0588801" limit="6"]

#Choosing the display

Cards are always fixed-width and container-responsive: JReviews fits as many across as the available width allows and never crams them. You control two things, how wide each card is and how the row of cards is arranged:

• How wide is each card? card_width sets a card width: sm (224px), md (256px), lg (288px), or xl (384px). Leave it off (or card_width="") to keep the width that comes with the layout. Cards never shrink below the width you pick; the grid just fits fewer across on a narrow screen. (card_size also works.)
• Fixed or sliding? Add slider="1" to slide the cards horizontally; leave it off for a fixed grid.
• A single row or a grid? rows="1" (the default) keeps a single row; rows="2" or more makes a grid that many rows tall. Inside the slider, rows="2" or more becomes a sliding grid that scrolls sideways.

Use columns to cap how many columns the fixed grid can grow to (the default fits as many as the width allows); it has no effect on the slider. limit sets how many listings to load. Add limit_mobile to load fewer on phones; omit it to use limit on every screen. The modern listings render does not page, so the slider simply shows what fits and you scroll through the rest.

#Listings Layouts

Under the modern engine the themelayout attribute resolves in this order:

1. A built-in layout preset, referenced by its readable id: list-item, vertical, horizontal, postcard, poster, or vertical-masonry.
2. A saved custom layout, referenced by its id from the Layout Customizer. Custom layouts are matched by id only (not by name), and the id match is case-sensitive.
3. If the value matches neither, JReviews falls back to the default list-item layout. Logged-in administrators and editors (and the CP Shortcode Preview) see an inline "layout not found" notice; regular visitors just get the default layout with no message.

[jreviews type="listings" themelayout="postcard" columns="3" limit="6"]

#Listings Shortcode Attributes

Selection attributes (which listings to show):

Display and layout attributes (how the listings look). The first four control how the cards are arranged (see Choosing the display); themelayout and the rest each override the corresponding setting of the resolved themelayout:

#Deprecated Listings Attributes

#Reviews Shortcode

Below you can find some usage examples for the reviews shortcode.

Reviews for a single listing with alias "westville-east"

[jreviews type="reviews" listing_alias="westville-east" link_title="{review_title}" show_comments="1"]

10 most helpful user reviews

[jreviews type="reviews" reviews_order="helpful" reviews_type="user" limit="10"]

Latest reviews

[jreviews type="reviews" reviews_order="latest" limit="6"]

Reviews show as a fixed grid by default. Add slider="1" to slide them sideways instead, and slider_mobile="1" to do the same on phones. Use card_width for how wide each review card is, columns to cap how many fit across, and rows for a sliding grid that is several rows tall. These are the same display controls as the listings shortcode.

#Reviews Shortcode Attributes

There are many attributes you can use to customize the output of the reviews shortcode:

#Field Shortcode

The Field shortcode can show the output of a single field from any listing anywhere on the site. The shortcode format is:

[jreviews type="field" name="jr_state" listing_alias="blue-hill"]

[jreviews type="field" name="jr_state" listing_id="111"]

You can specify the listing for which you want to show the field using the listing_alias or listing_id attributes.

Under the modern engine the field output honors the field's per-field Show Title setting automatically, so a field configured to hide its title renders just the value.

You can also omit the listing attributes and the shortcode will try to auto-detect the listing from the current page (listing detail, view all reviews for a listing or review discussion pages). If a valid page cannot be auto-detected, the shortcode is removed and the output suppressed.

If you place the shortcode in a template file, you can combine it with custom PHP code. For example, in an event listing type, you can inject the venue related listing ID into the listing_id attribute to show venue custom fields in the event page.

Show venue address in event page

<?php if (isset($listing['Field']['pairs']['jr_venue'])): ?>

  [jreviews type="field" name="jr_address" listing_id="<?php echo $listing['Field']['pairs']['jr_venue']['real_value'][0];?>"]

<?php endif;?>

#Manage Listing

Since JReviews v3.12.0

The Manage Listing shortcode can show the listing manage dropdown. When placed anywhere within the listing detail page, the shortcode code format is:

[jreviews type="manage_listing"]

It's also possible to disable the dropdown and instead show a plain list of options:

[jreviews type="manage_listing" dropdown="0"]

When using the shortcode outside the listing detail page, it's necessary to indicate to the shortcode which listing the dropdown is for. To do this, pass the corresponding listing ID in the listing attribute.

[jreviews type="manage_listing" listing="23"]

#Listing Cover

Since JReviews v3.13.3/v4.0.9

The listing cover shortcode allows displaying the listing cover in the listing detail page outside of the JReviews output. For example, in a Joomla module or WordPress widget.

[jreviews type="listing_cover" class="fwd-w-full fwd-h-96 fwd-object-cover"]

The shortcode allows using the class and style attributes to pass CSS classes and custom CSS styles so you can customize the output as needed.

#Listing Favorites

Since JReviews v4.3.0

The Listing Favorites shortcode can show the favorites add/remove button. When placed anywhere within the listing detail page, the shortcode code format is:

[jreviews type="listing_favorites"]

When using the shortcode outside the listing detail page, it's necessary to indicate to the shortcode which listing the dropdown is for. To do this, pass the corresponding listing ID in the listing attribute.

[jreviews type="listing_favorites" listing="23"]

#Listing MyLists

Since JReviews v4.3.0

The Listing MyLists shortcode can show the MyLists add-to-list button. This type is provided by the MyLists add-on (it is not a core shortcode type), so it is available when that add-on is installed. When placed anywhere within the listing detail page, the shortcode code format is:

[jreviews type="listing_mylists"]

When using the shortcode outside the listing detail page, it's necessary to indicate to the shortcode which listing the dropdown is for. To do this, pass the corresponding listing ID in the listing attribute.

[jreviews type="listing_mylists" listing="23"]