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.71 Latest Version:
Release Notes

A free membership is required to download PeoplePods.

  Already Registered? Login

Recent Posts from Our Blog

0.71 Released - Inbox bug fixed

PeoplePods version 0.71 has been released. This version is a maintenance release which fixes a problem with the private messaging inbox. Existing PeoplePods sites can upgrade to the newest...

PeoplePods powers MediaBugs.org and the Helsinki Design Lab

April saw the launch of two brand new PeoplePods-powered applications. These new sites use the latest version of PeoplePods - 0.8 - which will be available to download at the end of...

Version 0.7 Now Available

Last night, I uploaded a new release of PeoplePods: version 0.7. The most exciting new features in this version are: new dynamic image resizing options, a faster comment polling system, new ways...

Developer Preview Launch!

I am very excited to announce the launch of PeoplePods version 0.666, THE DEVELOPER PREVIEW! After tons of hacking, I have tweaked the last line of code, and I am finally ready for a wider audience...