group

Show items from group(s)

Accepted values: string (“me” or any group name)

Content types: All

Related settings: exclude_group

data-options="id=123
/live/json/events

Default behavior

When no group setting is specified, widget and API results will be returned from all groups, unless they’ve had “Exclude from site-wide results” selected in the Edit Group settings.

Setting multiple groups

The group setting allows multiple values. You can set these by adding multiple lines:

<arg id="group">Biology</arg>
<arg id="group">Chemistry</arg>
<arg id="group">Physics</arg>

Or you can bar-separate your preferred values.

<arg id="group">Biology|Chemistry|Physics</arg>

These same approaches also work with embedded widgets (&group=Biology&group=Chemistry) and the API (/group/Biology/group/Chemistry).

If one or more group settings have been enabled in a saved widget or widget template, you can zero them out by setting an empty value:

<!– this will only show Biology results –>
<arg id="group">Chemistry|Physics|Mathematics</arg>
<arg id="group"></arg>
<arg id="group">Biology</arg>

Special value: group=me

In LiveWhale CMS, you can set a widget’s group to “me” – this will show content from the group that owns the page wherever the widget is placed. This can be used for creating global widgets like “My Events,” “My Faculty and Staff,” or “My Top News.”

Interaction with group configuration: “Exclude from site-wide results”

By default, widgets or requests with no group setting will show results from all groups. However, if on the Edit Group page, “Exclude from site-wide results” has been selected, that group’s content will not be returned unless it is explicitly requested using the group setting. This is intended for test and pre-production groups, as well as special groups like Magazine or Gala that you might not want showing up in typical widgets and search results.

Common Settings

All Settings