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

$POD->getPeople()

$people = $POD->getPeople($conditions,$sort,$count,$offset);

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

Parameters

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

Examples

Get a simple list of the people who have logged in most recently:

$most_recent = $POD->getPeople();

Get a list of people who have a certain specific meta field:

$people = $POD->getPeople(array(
  'm.name'=>'special'
));

Get a list of people who have a specific value for a specific meta field:

$people = $POD->getPeople(array(
  'm.name'=>'special',
  'm.value'=>'featured'
));

Get a list of people with a specific flag - this example will return any person flagged by any other user with the "warn" flag:

$people = $POD->getPeople(array(
  'flag.name'=> 'warn',
));

Get a list of people with a specific flag/value set - this example will return any person flagged by any other user with the rating flag set to 5:

$people = $POD->getPeople(array(
  'flag.name'=> 'rating',
  'flag.value'=> '5'
));

Get a list of people with a specific flag set by a specific user. This is how you would pull a list of a person's friends:

$person = $POD->currentUser();
$friends = $POD->getPeople(array(
  'flag.name'=>'friend',
  'flag.userId'=>$person->get('id');
));

Get a list of people who flagged a user with a specific flag. This is how you would pull a list of a person's followers (people who have added the friend flag):

$person = $POD->currentUser();
$friends = $POD->getPeople(array(
  'flag.name'=>'friend',
  'flag.itemId'=>$person->get('id');
));

Get a list of people who flagged a specific piece of content with a specific flag. This is how you would pulla list of all the people who have favorited a specific piece of content:

$favorite_users = $POD->getPeople(array(
  'flag.name'=>'favorite',
  'flag.itemId'=>$content->get('id')
));

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...