Skip to main content

Using our WordPress plugin

Written by Mike
Updated this week

Installation

  • Log in to your WordPress dashboard (usually yourwebsite.com/wp-admin)

  • Click on Plugins > Add New

  • Search for “Starboard Suite”

  • Click Install Now on the “Starboard Suite Reservation Calendar” plugin

  • After installation, click Activate

Configuration

  • Click the Starboard Suite Menu on the Dashboard

  • Enter your Starboard Suite subdomain (e.g., wildwoodcharters.starboardsuite.com).

  • Click Save Changes

Using Short Codes

Booking Lightbox

  • In the WordPress Dashboard, enter Edit mode on the Post or Page you want to include the Booking Lightbox link.

  • The Booking Lightbox link uses and opening and closing tag: [starboard-suite-lightbox]<link content>[/starboard-suite-lightbox].

  • The <link content> can be any HTML element (text, button, image, etc.) that will hyperlink to the Booking Lightbox.

  • For a simple Book Now link, enter [starboard-suite-lightbox]Book Now[/starboard-suite-lightbox].

Booking Lightbox Options
The Lightbox shortcode accepts the following options:

  • tour_type_id – open to a specific Event Type or parent Event Type

  • departure_location_id – open to a specific Departure Location or parent Departure Location

  • vessel_id – open to a specific Resource

  • width – specify the width of the lightbox (the default is 100%).

  • height—specify the height of the lightbox (the default is 100%).

  • max-height—specify the maximum height of the lightbox

  • max-width—specify the maximum width of the lightbox (the default is 1290px).

  • border-size—specify the border size (the default is 10px).

  • border-color—specify the border color with any valid CSS color (default is white).

  • hide-giftcertificate—hide the Buy Gift Certificates icon (default is false).

  • hide-concierge—hide the concierge login link (default is false)

  • show-printpass—show a print icon on the boarding pass (default is false).

  • notify-printpass-navigateaway—show an alert before closing the lightbox if the boarding pass has not been printed (default is false)

To specify any of the above options, enter them inside the opening tag, separated by spaces. For example, the following short code would create a link opening a Booking Lightbox that is 800px wide, a yellow border that is 30px and would hide the gift certificate icon:

[starboard-suite-lightbox width="800px" border-size="30px" border-color="yellow" hide-giftcertificate="true"]Book Now[/starboard-suite-lightbox].

Embedded Calendar

  • In the WordPress Dashboard, enter Edit mode on the Post or Page where you want the calendar to appear.

  • To embed the calendar with default settings, place the shortcode [starboard-suite-embedded] in the editor where you want the calendar to display. By default, the calendar will appear at 100% width and 600px height.

  • You can customize the size of the calendar by specifying the width and/or height attributes in the shortcode. For example: [starboard-suite-embedded width="400px" height="500px"].

  • You can also filter which events appear on the calendar by specifying the departure_location_id and/or tour_type_id. For example: [starboard-suite-embedded width="400px" height="500px" departure_location_id="10" tour_type_id="473"].

  • Additional display options include max-width, max-height, and border. For example: [starboard-suite-embedded width="400px" height="500px" border="3px solid red"].

  • Only the attributes listed above are supported by the shortcode.
    ​

Linking Menu Items

To have a menu item open the booking lightbox, do the following:

Did this answer your question?