Filtering Event Finder
Widgets offer endless customization options! Filters can be applied to the Event Finder in two ways:
- Attribute filtering is set using widget attributes before adding the widget to your webpage.
- URL filtering is appended to the URL when someone views the webpage.
Attribute Filters
Optional attributes can be used to create different versions of the widget for different purposes. For example, pages can be created for Congregations or Ministries and filtered for those pages. Adding filters via attributes presents a limited version of the Widget. Users cannot see or change the applied filters but can layer on other filters to further narrow results. For example, pages can be created for Congregations or Ministries and filtered for those pages.
- Congregation: Filters the results by a Congregation, Parish, or Campus.
- Attribute: congregationid
- Valid Value: Congregation ID
- Example:
congregationid="1"
- Key Word: Filters the result using keywords. Keyword search looks for a match in the Event Title Name, Event Description, Program Name, and/or Ministry Name, so choose your key word attribute strategically.
- Attribute: keyword
- Valid Value: Any keywords
- Example:
keyword="mission to mars"
- Month: Filters by a certain month.
- Attribute: monthid
- Valid Value: one value between 1 and 12 (1 = January, 12 = December)
- Example:
monthid="12"
- Ministry: Filters by a certain ministry.
- Attribute ministryid
- Valid Value: one Ministry ID (or empty, the default)
- Example:
ministryid="16"
- Sign-up Type: Filters by type of registration available. The default is empty.
- Attribute: signuptype
- Valid Value: "1" for Open Registration, "2" for Open Volunteer Opportunities, or empty for unspecified. "0" will display all events.
- Example:
signuptype="2"
- Event Type: Filters by a certain type of event.
- Attribute: eventtypeid
- Valid Value: one Event Type ID (or empty, the default)
- Example:
eventtypeid="3"
- Featured: Filters by showing only Featured Events. The default is empty.
- Attribute: isfeatured
- Valid Value: "true" (or empty)
- Example:
isfeatured="true"
- Program: Filters by a Program. The default is empty.
- Attribute: programid
- Valid Value: Program ID (or empty)
- Example:
programid="16"
- Limit Occurrence: Limits the number of occurrences people see for a series of events. The default is empty.
- Attribute: reduceseriesto
- Valid Value: Any number greater than or equal to 1. There is no limit to the number of events you want to show.
- Example:
reduceseriesto="3"
All attributes must be included before the opening Widget tag is closed. Attributes may be listed in any order and should be separated by a space (or other whitespaces). Each attribute's value should be wrapped in quotation marks. For example, this Event Finder defines the resource path, congregations, and ministries.
<mpp-event-finder target="https://example-church.com/events" congregationid="7" ministryid="8"></mpp-event-finder>
URL Filters
Search parameters are appended to the URL when accessing the widget page. Using URL filtering, users can see and change all filters in the User Interface. If you need to lock down aspects of the widget so users cannot change them, see Finder Widget Setup.
- Congregation: Filters by a Congregation ID
- Parameter: "congregationId"
- Valid Value: A single Congregation ID or empty for unspecified.
- Example:
?congregationId=1
- Key Word: Filters by key words
- Parameter: "keyword"
- Valid Value
- Empty for unspecified (the default value)
- URL encoded keywords
- Standard A-Z and 0-9 characters are all valid.
- Spaces should be replaced with a plus (+). Note: The is different from the Key Word Attribute filer, which does not require the plus.
- Other characters must be encoded.
- The easiest way to determine to encode is by searching using the criteria and copying from the resulting URL.
- Example:
?keyword=mission+to+mars
- Month: Filters by one month
- Parameter: "monthId"
- Valid Value: Any single Month between "1" and "12"
- Example:
?monthId=12
- Ministry: Filters by a Ministry ID
- Parameter: "ministryId"
- Valid Value: A single Ministry ID
- Example:
?ministryId=16
- Sign-up Type: Filters by Sign-Up Type. The default is empty.
- Parameter: "signUpType"
- Valid Value: "1" for Open Registration or "2" for Open Volunteer Opportunities, or empty for unspecified.
- Example:
?signUpType=2
- Event Type: Filters by a certain type of event.
- Parameter: "eventtypeid"
- Valid Value: one Event Type ID
- Example:
?eventtypeid=3
- Featured: Filters to show featured events. Default is empty.
- Parameter: "isFeatured"
- Valid Value: "True" for featured or empty for unspecified.
- Example:
?isFeatured=true
- Program: Filters by a Program ID
- Parameter: "programid"
- Valid Value: A single Program ID or empty for unspecified.
- Example:
?programId=1
?eventId=&programId=&congregationId=&keyword=&monthId=&ministryId=&signUpType=2