## Overview
In the WPDKUser class you find all method and properties loose in standard WordPress WP_User class.
/**
* Delete a user transient.
*
* @brief Delete
* @since 1.1.0
* @deprecated since 1.5.1 - Use WPDKUser::deleteTransientWithUser() instead
*
* @uses do_action() Calls 'delete_user_transient_$transient' hook before transient is deleted.
* @uses do_action() Calls 'deleted_user_transient' hook on success.
*
* @param string $transient Transient name. Expected to not be SQL-escaped.
* @param int $user_id Optional. User ID. If null the current user id is used instead
*
* @return bool true if successful, false otherwise
*/
function wpdk_delete_user_transient($transient, $user_id = null)
{
_deprecated_function(__CLASS__ . '::' . __FUNCTION__, '1.5.1', 'WPDKUser::deleteTransientWithUser()');
return WPDKUser::deleteTransientWithUser($transient, $user_id);
}
/**
* Create a WordPress user and return the user id on success, WP_Error otherwise.
*
* @since 1.7.3
*
* @param array $args {
* An array user data arguments.
*
* @type int $ID User ID. If supplied, the user will be updated.
* @type string $user_pass The plain-text user password.
* @type string $user_login The user's login username.
* @type string $user_nicename The URL-friendly user name.
* @type string $user_url The user URL.
* @type string $user_email The user email address.
* @type string $display_name The user's display name.
* Default is the the user's username.
* @type string $nickname The user's nickname. Default
* Default is the the user's username.
* @type string $first_name The user's first name. For new users, will be used
* to build $display_name if unspecified.
* @type stirng $last_name The user's last name. For new users, will be used
* to build $display_name if unspecified.
* @type string|bool $rich_editing Whether to enable the rich-editor for the user. False
* if not empty.
* @type string $date_registered Date the user registered. Format is 'Y-m-d H:i:s'.
* @type string $role User's role.
* @type string $jabber User's Jabber account username.
* @type string $aim User's AIM account username.
* @type string $yim User's Yahoo! messenger username.
* @type bool $enabled Set TRUE to enable user. Default FALSE.
* }
*
* @return int|WP_Error
*/
public function createWithArgs($args)
{
// For security reason an user must have a password
if (empty($args['user_pass'])) {
$args['user_pass'] = wp_generate_password(20, false);
/**
* Filter the auto generate user password.
*
* @param string $password A random alpha number password.
*/
$args['user_pass'] = apply_filters('wpdk_users_random_password', $args['user_pass']);
}
// Preset display name
if (empty($args['display_name'])) {
$args['display_name'] = WPDKUser::full_name($args['first_name'], $args['last_name']);
}
// Preset user role
if (empty($args['role'])) {
$args['role'] = 'subscriber';
}
$user_id = wp_insert_user($args);
if (is_wp_error($user_id)) {
return $user_id;
}
// Store IP Address
if (isset($_SERVER['REMOTE_ADDR']) && !empty($_SERVER['REMOTE_ADDR'])) {
update_user_meta($user_id, WPDKUserMeta::REMOTE_ADDR, $_SERVER['REMOTE_ADDR']);
}
// Disable user if required
if (false === $args['enabled']) {
/**
* Filter the user status before update.
*
* @param string $status The status id. Default `WPDKUserStatus::DISABLED`.
* @param int $user_id The user id.
*/
$status = apply_filters('wpdk_users_status', WPDKUserStatus::DISABLED, $user_id);
update_user_meta($user_id, WPDKUserMeta::STATUS, $status);
/**
* Filter the user status description.
*
* @param string $description User stats description.
* @param int $user_id The user id.
*/
$status_description = apply_filters('wpdk_users_status_description', '', $user_id);
update_user_meta($user_id, WPDKUserMeta::STATUS_DESCRIPTION, $status_description);
}
return $user_id;
}
