Home » Documentation » What is PeoplePods? » SDK Documentation » Object Definitions » PeoplePods Objects » $POD->getGroups()

$POD->getGroups()

$POD->getGroups($conditions,$sort,$count,$offset);

Get a stack of group objects that match the parameters you pass in.

Parameters

$conditions An associative array of stack parameters that describe the content you want to load. See the stack parameters document for constructing these arrays.
$sort A SQL style sort statement. Defaults to 'date DESC'
$count
Maximum number of pieces of content to return. Defaults to 20
$offset
Offset results by this many groups. (for use in paging)

Examples

Get a simple list of the most recent groups of any type.

$groups = $POD->getGroups();

The getGroups function can automatically link in information about group membership, so you can do things like get all the groups a user is a member of:

$person = $POD->currentUser();
$my_groups = $POD->getGroups(array(
  'mem.userId'=>$person->get('id')
));

Or, get all the groups a person has been invited to, but has not yet joined:

$person = $POD->currentUser();
$my_groups = $POD->getGroups(array(
  'mem.userId'=>$person->get('id'),
  'mem.type'=>'invitee'  // you might also use 'member' 'manager' or 'owner'
));

You can also query groups by flags and meta fields, in the same manner that you would content or people.

Be sure to check out the stack documentation for all the functionality the resulting stack will have!

  • Discuss This Document

No comments have been posted yet.

Download Download the latest version of PeoplePods!

0.81 Latest Version:
Release Notes

Join the PeoplePods developer network and get direct access to documentation, additional plugins, and our forums!

  Already Registered? Login

Recent Posts from Our Blog

Ben Brown on how running a community is like throwing a giant, never-ending party

An interview I did with OpenSource.com is now online!  Read it here. In it, I discuss how running an online community is like throwing a giant, never-ending party, how open source techniques...

SVN commits now live in the sidebar!

Since lots of updates are getting committed to the new PeoplePods SVN repository, I put the commit history in the sidebar of THIS SITE!  Now you can see the latest changes as they happen...