FAQ Q167: How do I fill out the Planyo plugin's parameters?

The plugin's parameters can be set on different levels. The easiest way is to change the default parameters in the plugin settings (note for Joomla/Drupal: the planyo module is meant by the term "planyo plugin" in this document and elsewhere in our documentation). You can also override any of the default parameters by adding a parameter to the URL of the page containing the planyo plugin or by setting the plugin's attribute string (called planyo_attribs in the source code).

You can use our Attribute string generator in order to generate the attribute string -- or see below for the full list of available parameters. The only one you have to change is Site ID. If you don't change it, the plugin will be connected to a demonstration site.

Parameter (UI)Parameter (attribute string)Description
Site ID(only set in plugin parameters)This is your Planyo site's ID. You'll need to create an account if you don't have a Planyo site yet.
Language of Planyo interfacelang or planyo_langThe default two-letter language code (e.g. EN, FR, DE etc.) of the user interface. Some CMSes make it possible to set this to auto-detect which will use the current user's language automatically as the default.
Default modemodeOne of: Search box (mode=search), Resource list (mode=resource_list), Upcoming availability (mode=upcoming_availability), Do nothing (mode=empty), Resource details (mode=resource_desc&resource_id=xxx), reservation form (mode=reserve&resource_id=xxx) (these two modes also require the resource ID passed in the resource_id parameter -- pass it either in the URL or using the attribute string). Metasites can also use the site listing mode (mode=site_list). This will determine what the plugin will display by default, that is, without any other parameters passed to it. You can either have it display a list of resources or it can be a search box used to search for available resources (upcoming availability is another type of search where the dates don't need to be filled out), or you can tell the plugin to display nothing. Please note that you can always change the default settings either by using one of the widgets (in the last step of site settings / integrate with my website), directly setting the URL parameters or by setting the plugin's attribute string. There are also some special modes which can be used only as part of the attribute string or URL parameters. Normally you wouldn't use them directly but they would be set by one of the widgets (available in the last step of site settings / integrate with my website) or by a tag from Q204 embedded as a link into an email sent to the customer. One of the modes can be also used directly as a link from any page of your website in case you use the shopping cart: mode=show_cart. This will be the same URL as the one you get with $(shopping_cart_url) and will show user's shopping cart contents and let them do a checkout. mode=show_coupons will present a list of coupons you offer -- these coupons can be then purchased by the customer using the payment gateway set up for your planyo site. mode=reservation_list -- shows a listing of existing reservations for given customer. This will only work if you decided to integrate your CMS login with the planyo plugin (in plugin's settings) and if the customer is logged into your website. Please note that the integrated login works only with some CMS systems like joomla, drupal, wordpress, modx, typo3.
Sort-by field choicessort_fieldsThis optional field is used in the search engine and upcoming availability mode. It will let the users choose the sorting criterium. Type comma-separated values that can be used for this purpose. If you only specify one value, the sorting criterium will not be selectable by the user but will be fixed e.g.: price. Possible values of this option include: price, name, random, site, and all custom resource properties (in form of prop_res_xxx, see Q205 for the list of resource properties available for your planyo site).
Additional fields of the search boxextra_search_fieldsThis optional field is used in the search engine mode. It will let the users choose additional search filters. If the search was initiated using a search box widget (code pasted from the last step of site settings / integrate with your website), you don't need to use this parameter, the additional fields will be added automatically. You can specify the search filters by passing a comma-separated list of custom resource properties (in form of prop_res_xxx, see Q205 for the list of resource properties available for your planyo site) or reservation form items (here the values would only be used to properly calculate the price quoted in the search results) -- in such case use the format rental_prop_xxx.
(can be only set in attribute string)ppp_hidden_fieldsThis is a comma-separated list of resource properties (prop_res_xxx) which will be used as search criteria. The values must be also spetified in the attribute string (see prop_res_xxx below) and these fields will be hidden in the search form. If you want the user to choose the values, add such criteria to extra_search_fields.
(can be only set in attribute string)ppp_horizontal_searchbox=1If you set this parameter, the fields of the search box displayed on the search results page (if present in the "search view" template) will be printed in a single line. Otherwise (by default) each search box field will be printed in a separate row.
(can be only set in attribute string)prop_res_xxxIn the search, resource list or upcoming availability modes, you can preset one of the custom resource properties' value (see Q205 for the list of resource properties available for your planyo site). For example, if you have a Location property, use this parameter this way: prop_res_location=Predefined Location
Ordering of resourcessortThis optional field is used in the resource list mode and lets you choose a different sorting criterium (possible values are: custom resource properties, random, name, price, site). For upcoming availability you can use the value time. In order to create a custom sorting criterium, you first need to create a new custom resource property and set its value for all of your resources and then specify the property name here (in form of prop_res_xxx, see Q205 for the list of resource properties available for your planyo site).
SEO friendly(only can be set in PHP or plugin versions in plugin parameters)By selecting this option you tell Planyo to generate static HTML code wherever possible (resource list or resource details) which will be indexed by search engines making the plugin SEO friendly. Otherwise content is always fetched via ajax. Please note that if you enable SEO-friendliness, you should clean up the cache in your CMS whenever you change a planyo setting, otherwise the original (cached) version may be used.
Javascript framework used(only set in plugin parameters)This option is available for all plugins except for Joomla and Drupal where these CMSes already come with either Mootools (joomla) or jQuery (drupal). In all other cases you can decide whether to use one or the other, also depending on whether you already include one of these libraries. In such case it's better not to add another one for optimization purposes. Please also note that jQuery (selected by default) is more compatible with other libraries. For example prototype (used with plugins such as LightBox) will work with the jQuery version, while the mootools version will cause problems.
Integrate with CMS login(only set in plugin parameters)If you use a login system of your CMS, you can also tell planyo to take advantage of this. Integrating with the CMS login has an advantage of the personal details being pre-filled. Depending on the CMS you use and the personal info saved in your database, sometimes the first time the user makes a reservation only some fields will be prefilled, such as the email address, but the next time they make a reservation, all fields will be prefilled. Another advantage of the login system is that you can display a list of all of customer's reservations made in the past. You can do this by using the tags described in Q214.
(can be only set in attribute string)res_filter_name, res_filter_valueThe resource list mode and the reservation form mode can display only specific resources, according to a filter defined by a custom resource property. The filter will only list the resources having the value of this property equal to the value specified by res_filter_value. The property name is specified in form of prop_res_xxx, see Q205 for the list of resource properties available for your planyo site. Note: if you want to use multiple filters, see the description of the prop_res_xxx parameter.
(can be only set in attribute string)ppp_upcoming_av_day_choices=c1,c2,c3, ppp_upcoming_av_fixed_days=dThe upcoming availability mode default choices of periods (for which the availability is show) presented to the user can be changed using one of these options. The first one lets you specify different durations (in days) shown in the dropdown (c1, c2 and c3). An example would be 2,3,4 which means availability in the next 2, 3 and 4 days will be selectable. An alternative format would be DD.MM.YYYY-DD.MM.YYYY which can be used as a choice as well (or DD.MM.YYYY-DD.MM.YYYY:label which also gives this choice a custom label). This represents a specific period identified by 2 dates instead of the next X days (starting at current date). An alternative format you can use for each period is MONTHPLUSx where x is a number (0..24), e.g. MONTHPLUS0 reperesents the current month, MONTHPLUS1 represents the next month. The parameter ppp_upcoming_av_fixed_days lets you set the duration to a fixed value (d) which means the dropdown is not shown. The start point is the current day if the single value (d) is numeric. Otherwise it must be a date range in format DD.MM.YYYY-DD.MM.YYYY.
(can be only set in attribute string)range_searchThis parameter only works in the search and upcoming availability mode. It determines the default search mode (the small search box whose HTML code you can copy&paste in site settings / integrate with my website / widgets will also be able to set the search mode). There are four search modes available: normal (range_search=0; this is the default) which will search for availability within the exact dates specified in the search box, flexible mode (range_search=1): in this mode the search finds also resources available for shorter periods within the date range specified in the search box, and flexible hour mode (range_search=day): in this mode the customer only specifies a single search date and the search finds all hours available within that day -- this is only used with hour-based resources, and the last one is flexible mode with extended range (range_search=extX where X is the number of days, e.g. range_search=ext3): this mode works just like the flexible mode (range_search=1) except that the dates entered by the customer in the search box are extended by X days. For example, range_search=ext2 would really search between Nov 8 and Nov 15 when the customer chooses the search between Nov 10 and Nov 13. You can also use the value range_search=flxX which works like extX but the period returned is guaranteed not to be longer than the search period entered by the visitor. It can be shorter and can be shifted by max X days before or after the search period.
(can be only set in attribute string)ppp_price_range=1, ppp_price_range_maxval=XThese parameters only work in the search and upcoming availability mode. When they are both present, they will add a price range slider to the search box so the customer can select the desired price range. By default this controls the full price but you can also set the parameter ppp_price_range_prtype=1 then the price range selected will be meant as price per day (or per night of stay).
(can be only set in attribute string)ppp_flex_option=flxX, ppp_flex_option=extXThis parameter only works in the search mode. Please see the range_search parameter above for the difference between flxX and extX search modes. Unlike the range_search parameter, using this parameter gives the visitor a choice of using a normal (fixed) search mode or flexible search (with up to X days of flexibility). E.g. ppp_flex_option=ext2 will give the visitor a choice of: normal search, extended by 1 day or extended by 2 days.
(can be only set in attribute string)ppp_duration_valuesThis parameter only works in the search mode (for the upcoming availability mode, see the ppp_upcoming_av_day_choices parameter). It lets you switch from displaying two dates in the search box (arrival and departure) or two sets of start and end time fields. Instead a single start date (or date and time) is displayed along with a drop-down which determines the duration. Please note that this is the default if any of your resources have predefined durations (in such case if you do NOT want to show a list of possible durations, simply set the value of ppp_duration_values to none). Otherwise you'll need to use this parameter to force this type of search box. The value of this parameter is a semi-colon separated list of durations, expressed in hours, e.g. ppp_duration_values=2;4;6 which means a choice of: 2-hour, 4-hour or 6-hour rental. You can also attach your own titles to the different values by using the colon character in each duration value, e.g. ppp_duration_values=2:2-hour rental;4:4-hour rental;6:6-hour rental or ppp_duration_values=24:single night;48:two nights;72:three nights
(can be only set in attribute string)separate-units=1, ppp_separate_ranges=1These parameters only work in the search mode. These parameters will result in similar entries being displayed as separate search results. separate-units=1will separate different units of a single resource and ppp_separate_ranges=1 will separate different available periods.
(can be only set in attribute string)ppp_dates_only=1, ppp_dates_only=nightIf you have resources of mixed types (hour- and day-based), then you can force a search with only dates by using these parameters. The first version will work like for day-based resources and the second one for night-based resources (where departure date can be booked by the next customer)
(can be only set in attribute string)ppp_fixed_weekday, ppp_fixed_durations, ppp_fixed_durationThese parameters only work in the search and upcoming av. mode and make sense only with the flexible mode (range_search=...) and ppp_separate_ranges=1. When using these parameters together, the search can be executed in a different mode: for example, the user specifies the start and end period (e.g months June through August) and the search results can show all weekly rentals starting on a Saturday. Fixed start weekday (values are in range 1 to 7, e.g. ppp_fixed_weekday=6 for Saturday or ppp_fixed_weekday=7 for Sunday) can be specified with ppp_fixed_weekday and fixed durations (comma-separated durations expressed in hours eg.g. ppp_fixed_durations=24,48 for 1 day and 2 day rentals) can be specified with ppp_fixed_durations. ppp_fixed_durations can also include custom labels, e.g. ppp_fixed_durations=4:half day,8:full day. ppp_fixed_duration can be used if the duration is always the same and fixed (e.g 1 week).
(can be only set in attribute string)ppp_refcodeReferer code. This parameter works with all modes as well as with the widgets. You can use it in order to track the original source of the booking. This is especially useful if you integrate planyo with multiple websites or if you embed calender previews or search forms on partner sites.
(can be only set in attribute string)ppp_auto_redirect=1If you add this parameter to the attribute string, once the reservation is made, the customer will be redirected automatically to the payment gateway website skipping the page which shows the status message and the payment button which by default the customer must click in order to go to the payment gateway.
(can be only set in attribute string)ppp_resfilterYou can limit IDs of resources shown (in the resource list or search modes) by specifying a comma-separated list. NOTE: in case of joomla, use a semi-colon-separated list, comma is interpreted by joomla in another way.
(can be only set in attribute string)ppp_show_fieldsIn the reservation modification view, you can force some fields to be show for being edited. At the moment, the only value you can specify is 'voucher'.
(can be only set in attribute string)planyo_classYou can force the top-level element of the planyo content to include a custom class on demand, for dynamic css styling
(can be only set in attribute string)site_idIf you're embedding the planyo plugin on the meta-site level, you can limit the content to a single site id which is a member of your meta-site
(can be only set in attribute string)start_date, one_date, end_date, start_time, end_timeFor the reservation form view, you can preset the dates / times not only to a fixed value (e.g. start_date=2021-01-01) but also to a relative one.The date parameters can be preset to today or tomorrow: start_date=today or start_date=tomorrow and the times can be preset to the next available slot (start_time=next)

Below are a few sample attribute strings:

mode=upcoming_availability: this sets the plugin's mode to the upcoming availability
mode=reserve&resource_id=33: this shows the reservation form for resource ID = 33
mode=search&range_search_1&extra_search_fields=prop_res_number_of_persons,prop_res_town: this sets the flexible search mode where the search will also return shorter availability within the date range specified and will give the customer two additional search criteria: number of persons and choice of town (both must be first defined as custom resource properties and their values must be set for all resources)
mode=resource_list&res_filter_name=prop_res_town&res_filter_value=New York&sort=prop_res_priority: this shows the list of resources whose Town property is set to New York. The resources will be sorted according to the priority property. Both the priority and town must be first defined as custom resource properties and their values must be set for all resources

Click here to go to the attribute string generation tool