Retreat Guru WordPress Plug-in

How to integrate Retreat Guru with your WordPress website to list programs.

We have two options for integrating Retreat Booking Guru with your website. If you are using WordPress to manage your site, we recommend that you use our WordPress plugin, which is available through the WordPress plugin repository. 

Alternatively, if you are not using WordPress, you can still embed programs on your site by using a small JavaScript snippet.

For WordPress websites:

  1. From your WP Admin, click on Plugins > Add New.
  2. Search for Retreat Booking Guru Connect.
  3. Click Install Now.
  4. Click Activate Plugin.
  5. Click Retreat Booking Guru > Settings, a new link in your admin menu.

  6. Add yourdomain to the subdomain field.

  7. Create two new pages in WordPress, a Programs page, and a Teachers page. Once created, connect these pages to the Programs Page and Teachers Page fields under Retreat Guru Settings.

  8. Scroll down and click Save.

You are all set to drop in table or list shortcodes on the page(s) of your choice to display your programs! 

Note: When creating the Programs Page and Teachers Page, make sure to set the Parent page to (no parent).  Otherwise, your listings may not load correctly.

Once you have installed the retreat guru plug-in, and properly set up the Retreat Guru Settings page, you can quickly add a table or a list of your retreats to your website using our shortcodes. These may be simply copied and pasted right into the WordPress page you would like them to be displayed on.

For more information on setting up a table or a list click on Program & Help under Retreat Booking Guru on your WP site: 

Using the program listing shortcode

Use the [rs_programs] shortcode to add a list of your programs to any WordPress post, page, or theme file. Simply insert the following into the contents of your page or post and it will automatically list out the programs you've added.

[rs_programs]

 

 

Only list one category

If you'd like to list only programs in a specific program category, add the category attribute with the value of that category in quotes. For example:

[rs_programs category="featured-events"]

With the above configuration, only programs assigned to the Featured Events category will be displayed. Create new program categories at Programs > (choose a program to Edit) > Information > Program Categories.

Hiding and showing program content in list

You may also add attributes to remove certain elements. In the example below, everything except the title will be hidden.

[rs_programs hide_photo hide_date hide_location hide_discount hide_text]

Limit how many Programs display on a page

To restrict the number of programs displayed, set a display limit by adding limit="#" to the shortcode where # is the number you want to be displayed. For example, to display 10 programs on a page:

[rs_programs limit="10"]

Show items that are not enabled by default

Add information on the program list page using the following attributes:

    • show_first_teacher_photo
      show the image of the first teacher (usually used in conjunction with hide_photo to show the teacher photo rather than the program photo)
    • show_first_price
      show the first/lowest price. Outputs "From $xxxx.xx".
    • show_price_details
      show the full price list. Outputs a full price list.
    • show_price_first
      show the lowest of the prices eg. From $50
    • show_more_link="More info ..."
      show a link to prompt guests to see more about the program.
      Optionally add a value to customize the text.
    • show_availability="Spaces"
      show the number of available spaces left.
      Optionally add a value to customize the label text.
    • show_availability_words="Availability"
      show the availability as a word eg: 'Full'.
      Optionally add a value to customize the label text.
    • show_register_link="Register now"
      show a button to link directly to the registration form.
      Optionally add a value to customize the text.
    • wait_list_text="Join waiting list"
      Customize the text for the Join waiting list button.

    An example with multiple attributes:

    [rs_programs show_first_teacher_photo show_first_price show_price_details show_more_link="see more..." show_availability="Spaces" show_availability_words="Availability" show_register_link="Register Now" wait_list_text="Join waiting list"] 

    For some of the shortcodes like show_more_link you can optionally add a text value to customize the text. For example, show_more_link="more info..." 

    The list page includes a link with the custom text.

    For other shortcodes like show_availability you can add a text value to customize the label, for example, show_availability="Spots left".

     On the list page, there will be a link with the custom label.

    Table view

    This view is useful when your programs are mainly identical except for the dates, location, or teachers. You can decide what data to show in the table list. All items are optional. Two examples are below:

    [rs_programs table show_date show_register_link]

    [rs_programs table show_title="Retreats" show_date="Dates" show_availability="Spaces" show_availability_words="Availability" show_teachers="Hosts" show_location="Location" show_price_details="Price" show_price_first="Price from" show_more_link="Details" show_register_link="Register" wait_list_text="Join waiting list"]

    Using shortcodes to customize column headers and text

    For some of the shortcodes like show_more_link you can optionally add a text value to customize the text, for example, show_more_link="Details".

    On the table view page, there will be a link with the custom text.

    Program extra display fields can be accessed using extra_display_field="My Title" where "My Title" is the exact title of the extra display field as configured in the program setup.

    Alternate program description URL

    If you run one program many times, you may wish to list the program description once on your own website and choose the table view to display available dates.

    Enter the URL for the page on your website in the "Alternate Description URL" field (inside More Program Details when editing your program).

    Adding the shortcode to a template file

    For webmasters who want to customize the position a program list, you can also implement this shortcode in a theme file using the following WordPress method:

    <?php echo do_shortcode('[rs_programs]'); ?>

    Customize the color of the register now button

    Available as an option on the listing plugins settings page.

    Teachers

    Show all teachers or by teacher category:

    [rs_teachers]

    [rs_teachers category="feature"]

    Show a specific teacher's bio and associated programs:

    [rs_teacher id=“xyz”] where "xyz" is the numerical Teacher ID.

    To find a Teacher ID, go to Programs > All Teacher Bios and click on a teacher's name. The Teacher ID will appear in the new page's URL as post=xyz where "xyz" is the numerical Teacher ID.

    Viewing Categories via URL

    You can see program and teacher categories by just using a URL. If your main program URL is '/retreats/' then go to /retreats/category/featured-events/ to see just those categories. "Teachers" works in a similar manner.

    Simple Register Button

    Make a register now button by adding the Program ID. For example, a register now button for the program with Program ID = 33 would be:

    [rs_register_button id='33']

     

     


    rg-favicon-32 We'd love to hear from you. Did you find this article helpful? Are you aware of any additional information we should add? Would you like to suggest a topic for another article? If so, please contact your friendly support guru.