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

$POD->getGroup()

Returns one specific Group Object. This function can be used to load an existing group from the database, or create a new group.

Loading a Group

To load an existing piece group, pass in ONE of the following parameters:

  • id - db id of the group
  • stub - unique stub of the group

The vast majority of the time, you will load specific groups by their stubs. For example, the following code will load the group with the stub name 'awesomeville'

$content = $POD->getContent(array(
  'stub'=>'awesomeville'
));

Creating Groups

To create a group, you can either load an empty group object and set values for its fields, or pass in default values to the constructor. Surprising, I know.

Create a brand new, empty group object:

$new_group = $POD->getGroup();
$new_group->set('groupname','Music Learning Club Austin');
$new_group->set('description','A club where Austin people learn music.');
$new_group->save();

Or, pass in values:

$new_group = $POD->getContent(array(
  'group_name' => 'Ebola Research Group',
  'description' => 'Blood Everywhere!!!!!'
));
$new_group->save();

Errors

Be sure to check for errors! In some instances, the content object may not be created properly, and will throw an error.

if (!$new_group->success()) {
  echo $new_content->error();
}
  • 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...