PHP Interface Themosis\User\IUser

Exibir arquivo Open project: themosis/framework

Public Methods

Method Description
addFields ( array $fields, string $capability = 'edit_users' ) : Themosis\User\IUser Register custom fields for users.
addSections ( array $sections ) : Themosis\User\IUser Register sections for user custom fields.
current ( ) : User Look at the current user and return an instance.
get ( integer $id ) : User Return a User instance using its ID.
make ( string $username, string $password, string $email ) : User | WP_Error Create a new WordPress user.
validate ( array $rules = [] ) : Themosis\User\IUser Register validation rules for user custom fields.

Method Details

addFields() public method

Register custom fields for users.
public addFields ( array $fields, string $capability = 'edit_users' ) : Themosis\User\IUser
$fields array The user custom fields. By sections or not.
$capability string The minimum capability in order to save custom fields data.
return Themosis\User\IUser

addSections() public method

Register sections for user custom fields.
public addSections ( array $sections ) : Themosis\User\IUser
$sections array A list of sections to register.
return Themosis\User\IUser

current() public method

Look at the current user and return an instance.
public current ( ) : User
return User

get() public method

Return a User instance using its ID.
public get ( integer $id ) : User
$id integer
return User

make() public method

Create a new WordPress user.
public make ( string $username, string $password, string $email ) : User | WP_Error
$username string
$password string
$email string
return User | WP_Error

validate() public method

Register validation rules for user custom fields.
public validate ( array $rules = [] ) : Themosis\User\IUser
$rules array
return Themosis\User\IUser