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

$POD->getPerson()

Returns a Person Object. This function can be used to load an existing person from the database, or to create a new person object.

Loading A Person

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

  • id - user's db id
  • nick - user's nick
  • email - user's email
  • authSecret - user's authentication secret
  • passwordResetCode - user's password reset code (for use by the reset password script in the core_authentication Pod)

For example, the following code will load user id 1:

$person = $POD->getPerson(array(
  'id'=>1
 ));

This will load the user who registered with the name 'Chester':

$person = $POD->getPerson(array(
  'nick'=>'chester'
 ));

Creating a Person

You can create a new person object either by passing 0 parameters to this function, OR by passing a nick, email and password.

Create a brand new, empty user:

$new_user = $POD->getPerson();
$new_user->set('nick','Chester');
$new_user->set('email','chester@xoxco.com');
$new_user->set('password','foobar');
$new_user->save();

Create a new user by passing in all the deets:

$new_user = $POD->getPerson(array(
  'nick'=>'Chester',
  'email'=>'chester@xoxco.com',
  'password'=>'foobar'
 );
$new_user->save();

Errors

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

if (!$new_user->success()) {
  echo $new_user->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...