Widget Parameters

These are some additional parameters that can be used for the widget, in addition to those available on the widget builder.

In this article you’ll find:

  • Parameter Details
  • Filtering Parameters
  • Output Parameters
  • Related Articles

Parameter Details

Each parameter should be passed in as standard parameter in the widget URL.

Parameters marked as array can be specified as array parameters (example: venues[]=1&venues[]=2) or comma separated values (venues=1,2). The two forms cannot be mixed.

Boolean parameters are true for values of 1, y, yes, true. In many cases, the presence of the parameter is all that is required. (When in doubt, don’t include false parameters).


Filtering Parameters

Parameter Description Type Default
num number of events to return (1-50) number 10
days number of days in the future to look at (1-365) number 7
start date that the widget should start from (YYYY-MM-DD) date today
venues only return events at these venues (ID or username) array none
school only return events assigned to these schools (ID or username) array platform specific
campuses only return events assigned to these campuses (ID or username) array platform specific
groups only return events assigned to these groups (ID or username) array none
skip_recurring do not include recurring events boolean FALSE
all_instances show all instances of recurring events (instead of only the next) boolean FALSE
picks only include featured events boolean FALSE
sponsored only include events marked as “sponsored” boolean FALSE
tags return events with any of these tags or keywords array (string) none
types return events with any of these filter values array (type ID) none
exclude_types exclude events matching these filter values array (type ID) none
match_all controls matching requirements for tags/types>When not set (default), matches events that have a least one of the listed tags or types> When all, matches events that have all listed tags and types> When any, matches events that have at least one of the list tags and types string none

Output Parameters

Parameter Description Type Default
hidedesc hide descriptions boolean FALSE
hideimage hide images boolean FALSE
image_size return tiny 20×20, small50x50, medium 80×80, big 200×150, big_300 300×225 string small
show_keywords show keywords assign to events boolean FALSE
show_times show event start times boolean TRUE
show_year show the year of the event date boolean FALSE
show_types show event types below the event description boolean FALSE
style suppress default style string none
target_blank open event and venue links in a new window boolean none
html_descriptions output the raw HTML in event descriptions boolean FALSE
format=rss convert to RSS feed html

Related Articles