This method allows you to change a user's password directly through the API without letting the user fill in a form.

$uid is the ID of the user you wish to change the password for, and $password is the unencrypted password.

This method returns TRUE on success and FALSE on failure.

This method allows you to create new user profiles on your site.

$data is an array of data about the user:

In addition to these built-in fields you can supply values for any fields you have defined in the profile XML for your site.

$options is an array of meta data about the action you are performing:

The method returns the ID of the new profile. If anything goes wrong during the process, the built-in error handling will be used.

You can use this to check if a user (identified by an email address) is already registered at the site. Users in all states will be matched.

The method returns a boolean - TRUE if the user exists, FALSE otherwise.

This method returns a complete HTML form that allows a logged in user to change his password. If the user is not logged in the method will return FALSE.

$options is an optional hash that currently can have only one key: trans, which is another hash containing replacements for the strings used in the form. Below is a list of strings that can be overwritten. You can overwrite any number of these.

Here is an example changing just a couple of strings:

<?php

$options = array(
                 'trans' => array(
                                  'CHANGE_PASSWORD' => 'Change it, baby',
                                  'PASSWORD_MISMATCH' => 'These are not remotely identical....'
                                 )
                );

echo M2_User::getChangePasswordForm($options);

?>

Returns a user profile as an array with the field names as keys. This includes any fields you may have added by using the profile XML mechanism.

$uid is the ID of the user you are looking for - if not supplied the session is inspected to see if there is a user logged in and then his profile data is returned.

Groups memberships are returned as an array of group IDs and group developer keys, if available.

This method returns a complete HTML form that allows any registered user to retrieve a new password for the system, simply by pounding in his email address.

$options is an optional hash that currently can have only one key: trans, which is another hash containing replacements for the strings used in the form. Below is a list of strings that can be overwritten. You can overwrite any number of these.

Here is an example changing just a couple of strings:

<?php

$options = array(
                 'trans' => array(
                                  'LOGIN_SENT' => 'You gotta new password coming right at ya...',
                                  'NOUSER' => "Nope, don't know you, pal"
                                 )
                );

echo M2_User::getLostPasswordForm($options);

?>

Returns an array with a simple count of how many users exist in the four built-in states: REG_PENDING, ACTIVE, SUSPENDED and SUSPENDED_BY_BOUNCE

Checks if the currently logged in user is in the group specified by $groupID. $groupID can be either the ID of the group, or the developer key set in the administrative pages.

Returns TRUE if the user is in the queried group, FALSE if not.

Log in a user programatically. You can do this without knowing the user's password, but if you provide $password, the user must be authenticated by Moski2.net and the password must match.

If you provide a $groupID the login will only succeed if the user is in the specified group.

With this method you can search the user base. $options is an array of parameters - here are the keys and explanation of which values to supply:

<?php

$options = array('fields' => array('first_names' => 'Peter'));
$res = M2_User::search($options);

echo '<ul>';
foreach($res as $user) {
  echo '<li>' . $user['first_names'] . ' ' . $user['last_name'] . '</li>';
}
echo '</ul>';

?>

The return value is an array of all users matching the search criteria. Each user is represented as an array with all the user fields as keys - just like M2_User::getData().

Use this method to update an existing user profile.

$uid is the ID of the user you wish to update and $data is an array of profile settings, exactly like the one you supply to M2_User::createUser().

Fields that are not supplied in your $data array will be left untouched, meaning that if you wish to wipe a field you should provide an empty string for it instead of leaving it out of your $data.

This method returns TRUE or FALSE depending on whether it succeeds or not. If anything goes wrong during the process, the built-in error handling will be used.