Shortcode Explanation and Usage

Using the widget shortcode can be useful for various reasons including further integration into your WordPress post and page content beyond the range of widgetized sidebars. There are two shortcodes found in Yelp Widget Pro: [yelp-widget-pro] and [yelp-widget-pro-map] Yelp Widget Pro shortcode examples can be found on the Yelp Widget Pro Demo site.

[yelp-widget-pro] Usage

The yelp-widget-pro shortcode allows you to display Yelp data exactly how you would in the widget. Simply set the options to customize a shortcode that’s perfect for your use case. To get started, the most basic usage of the shortcode requires you choose an API option: Yelp Search Method Basic Usage Example:

Notice the required argument id.

Yelp Business Method Basic Example:

Notice the required arguments of term and location. For more information on which API method to use please visit: Yelp’s APIs Explained for use with Yelp Widget Pro

Output Options

You can use the shortcode within your page and post content as you would any normal shortcode. Ensure you are using the shortcode within the WordPress loop. Here is a very basic use of the shortcode:

Want to use the shortcode within your theme files? You can output the shortcode using PHP and the do_shortcode function for use within your theme files like so:

Shortcode Options

The Yelp Widget Pro shortcode options vary depending on how you would like to use the widget. The following is a resource displaying various shortcode options that are supported by the plugin.

Search Method

The Search Method allows you to display various businesses based on a search term and location. This method does not support the display of Yelp reviews due to Yelp’s API limitations. Required: the location argument is required alongside the term argument.

term

For use with Search Method Yelp widgets. Use this option to display a business listings based on a search term. The expected value is a basic search term such as bars, coffee shops, restaurants, etc.

location

For use with Search Method Yelp widgets. This method is required to search a specific area for your specific term. Required: location is a required argument. The default location, if none is specified, is “San Diego”.

limit

Set the number of results returned by the search query. The default value is “3”

profile_image_size

Customize the size of the business profile image for all results. The default value is “60×60”

• 40x40 – extra-small profile image size (40×40)
• 60x60 – small profile image (60×60)
• 80x80 – medium profile image (80×80)
• 100x100 – large profile image (100×100)

Business Method

The Business Method allows you to display a specific business listing based on the Yelp Business ID. How to get a business on Yelp’s Business ID. Note, this is the only method that support displaying Yelp reviews.

id

For use with Business Method Yelp widgets. Use the “id” argument to display a singular business. The expected value is the Yelp business ID.

reviews

Display 3 Yelp review snippets for each business. The default value is “false”

reviews_filter

Default: none. Set the minimum star rating of the reviews that should appear on your site.

avatar

Customize the size of the reviewer’s profile image (avatar). The default value is “60×60”

• 40x40 – extra-small profile image size (40×40)
• 60x60 – small profile image (60×60)
• 80x80 – medium profile image (80×80)
• 100x100 – large profile image (100×100)

hide_read_more

Hide the “Read Full Review” link below each individual review. The default value is “false”

custom_read_more

Customize the “Read Full Review” hypertext below each individual review. The default value is “Read Full Review”

Global Options

The following options work with Yelp Widget Pro regardless of API Method. You may add the following options to your shortcode parameters to enhance the performance and functionality.

cache

Cache API requests from Yelp for faster loading and conservation of API requests. By default, Yelp only allows 100 request per day. Caching requests will greatly improve performance and save requests.

• 1 Hour
• 3 Hours
• 6 Hours
• 12 Hours
• 1 Day
• 3 Days
• 1 Week

Note: cache=”None” can be used for testing. You should set it to cache=”1 Week” when testing is complete.

map

Display a Google map displaying one or many listings. The default value is “false”.

map_disable_scroll

Disable the use of the mousewheel to zoom in and out of the map. This option is helpful if your map is getting in the way of scrolling. The default value is “false”.

map_position

Specify whether to display the Google Map above or below the output. The default value is “below”.

• above
• below

address

Display the business address. The default value is “false”.

phone

Display the business phone number. The default value is “false”.

target_blank

Specify whether links open in a new window or not. Default option is “true”.

no_follow

Specify whether remove rel=”nofollow” to links. Default option is “true”.

align

Float the Yelp widget output right, left or no float value at all. The default value is “right”.

• left – align the widget output to the left
• right – align the widget output to the right; default value
• none – no float

width

Customize the widget’s width using this argument. If you wish to customize the width the widget’s default value. Be sure to use pixel or percentage values.

See our “Shortcode Alignment” demo page for additional code examples specifically when combining “width” with “alignment”.

[yelp-widget-pro-map] Usage

The [yelp-widget-pro-map] shortcode allows you to output a powerful Google Map listing various Yelp businesses by a search term and location.

Options

location

Set the location for this widget using the name of a place, such as “Tucson, Arizona” or “1600 Amphitheatre Parkway, Mountain View, CA”. The value you input is run through Google Maps’ Geocoding Service. The default value is “San Diego”.

search_term

Set the default search term for the map, such as “Sushi” or “Coffee”. The default value is “Restaurants”.