[groups-listing]

Renders the BuddyPress groups directory. Requires the Groups component. If Groups is disabled, the shortcode shows a “please enable the group component” notice instead.

Basic usage

[groups-listing]
[groups-listing type="popular" per_page="6"]
[groups-listing grid="yes" loop_layout="two"]
[groups-listing status="public"]
[groups-listing orderby="name" order="ASC"]

Attributes

These are the exact attributes and defaults the shortcode accepts.

Attribute	Default	Description
`title`	(empty)	Heading shown above the listing. Empty means no heading.
`type`	`alphabetical`	Ordering shortcut. Standard values include `active`, `newest`, `alphabetical`, `popular`, `random`. See the ordering note below.
`order`	`DESC`	Sort direction, `ASC` or `DESC`, used with `orderby`.
`orderby`	`last_activity`	Field to order by, for example `last_activity`, `name`, `date_created`.
`page`	`1`	Page number.
`per_page`	`20`	Groups per page.
`max`	`false`	Maximum number of groups to return.
`show_hidden`	`false`	Set to `true` to include hidden groups.
`status`	(empty)	Limit to a group status: `public`, `private`, or `hidden`.
`page_arg`	`grpage`	Query-string argument used for pagination.
`user_id`	`false`	Limit to a user’s groups.
`slug`	`false`	Limit to a group by slug.
`search_terms`	`false`	Search keywords.
`group_type`	`false`	Group type slug to filter by.
`group_type__in`	(empty)	Comma-separated group types to include.
`group_type__not_in`	(empty)	Comma-separated group types to exclude.
`meta_query`	`false`	Group meta query.
`use_compat`	theme value	Theme-compat flag; defaults to the site’s BuddyPress theme-compat setting.
`include`	`false`	Comma-separated group IDs to include.
`exclude`	`false`	Comma-separated group IDs to exclude.
`parent_id`	`0`	Parent group ID for hierarchical groups.
`update_meta_cache`	`true`	Whether to prime the group meta cache.
`container_class`	`group`	Extra CSS class on the wrapper.
`grid`	`yes`	`yes` for a grid layout, `no` for a plain list.
`loop_layout`	`three`	Grid columns when `grid="yes"`: `one`, `two`, `three`, or `four`.

Notes

Ordering vs type. Inside BuddyPress, type overrides orderby and order. Because this shortcode defaults type to alphabetical, a custom orderby or order would normally be ignored. To fix this, when you set orderby or order to anything other than the defaults and leave type at alphabetical, the shortcode drops the default type so your ordering applies. An explicit type= you pass still takes priority, matching BuddyPress behaviour.
status. The status attribute (added in 3.0.0) limits the directory to a single group status. It only takes effect when set; empty means all statuses the visitor may see.
Reign theme. When the active theme is Reign, the directory container classes and grid layout are replaced with Reign’s own group-directory classes.
BuddyBoss. When the BuddyBoss Platform is active, the groups template switches to the BuddyBoss variant automatically.
Empty and false attributes are stripped before the query runs, so they do not constrain results.