05.4 User Functions

User Functions

Use the to work with the user and the session

function: user_id()

Returns the current user id. If the user is not logged returns false;

$user_id = user_id();

function: get_users($params)

Returns the array of users

Parameters for get_users

parameter	description
id	the id of the content
created_on	the date of creation	strtotime compatible date
updated_on	the date of last edit	strtotime compatible date
last_login	datetime of the last login
last_login_ip	the last login ip address
username	username for login
email	email for login
password	password for login
first_name	user first name
last_name	user last name
thumbnail	src for the profile picture
is_verified	flag for verified email address	"n" or "y"
is_active	indicated if the user account is active	"y" or "n"
is_admin	indicated if the user is admin	"y" or "n"

Usage:

$users = get_users('email=example@example.com');

$admins = get_users('is_admin=y');

function: user_login($params)

Logs in a user into the CMS

also avaiable via the REST api at http://yoursite/api/user_login

//login a user

$login_data = array();
$login_data['username'] = 'admin';
$login_data['password'] = '123456';
$login = user_login($login_data);

var_dump($login);

// On error
array(["error"]=> string(41) "Please enter right username and password!" );


// On success
array(["is_logged"]=> string(3) "yes" ["user_id"]=> string(1) "1" ["success"]=> string(18) "You are logged in!");

function: logout()

Logs out a user

also avaiable via the REST api at http://yoursite/api/logout

//log out a user
logout(); 

function: user_register($params)

Register new user

(requires capcha) Call via the REST api at http://yoursite/api/user_register

 
<form method=post>
    <input type="text" name="username">
    <input type="password" name="password">
    <input type="text" name="capcha">
    <img src="<?php print site_url('api_html/capcha'); ?>">
    <input type="submit" name="register">
</form>