• Home
• WPDKUsers

PHP Class WPDKUsers

## Overview This is a singleton class for manage all WordPress users and adding a several extension for control, checking, login and more. ### User meta See the WPDKUserMeta Show file Open project: wpxtreme/wpdk Class Usage Examples

Public Methods

Method	Description
admin_print_styles_users_php ( )	Fires when styles are printed for a specific admin page based on $hook_suffix.
authenticate ( string $email, string $password ) : integer | boolean	Try to authenticate an user without log-in in the system. This method is very different by signIn().
avatar ( integer $id_user = null, integer $size = 40 ) : WPDKHTMLTagImg | boolean	Return an instance of WPDKHTMLTagImg class
create ( string $first_name, string $last_name, string $email, boolean | string $password = false, boolean $enabled = false, string $role = 'subscriber' ) : integer | WP_Error	Create a WordPress user and return the user id on success, WP_Error otherwise.
createWithArgs ( array $args ) : integer | WP_Error	Create a WordPress user and return the user id on success, WP_Error otherwise.
deleteUsersMetaWithKey ( string $key )	Delete the user meta with $key from all users.
delete_user ( integer $id_user )	The delete_user action/hook can be used to perform additional actions when a user is deleted.
deleted_user ( integer $id_user )	The deleted_user action/hook can be used to perform additional actions after a user is deleted.
edit_user_profile ( WP_User $profileuser )	Fires after the 'About the User' settings table on the 'Edit User' screen.
edit_user_profile_update ( integer $user_id )	Fires before the page loads on the 'Edit User' screen.
gravatar ( integer $id_user = null, integer $size = 40, string $alt = '', string $default = 'wavatar' ) : string | boolean	Return the HTML markup of tag img with the user gravatar. FALSE otherwise.
init ( ) : WPDKUsers	Return a singleton instance of WPDKUsers class
logout ( )	Force an user logout when disabled or if in GET you pass wpdk_logout.
personal_options ( WP_User $profileuser )	Fires at the end of the 'Personal Options' settings table on the user editing screen.
personal_options_update ( integer $user_id )	Fires before the page loads on the 'Your Profile' editing screen.
profile_personal_options ( WP_User $profileuser )	Fires after the 'Personal Options' settings table on the 'Your Profile' editing screen.
show_user_profile ( WP_User $profileuser )	Fires after the 'About Yourself' settings table on the 'Your Profile' editing screen.
signIn ( string | integer $user, string $password, boolean $remember = false ) : boolean	Do a WordPress Sign in and call filters and action. Return TRUE if success, FALSE for access denied.
signout ( )	Perform signout. This method is an alias of wp_logout()
userWithMetaAndValue ( string $meta_key, string $meta_value ) : integer	Return the User id with meta key and meta value.
user_contactmethods ( $contacts )	Filter the user contact methods.
usersWithCaps ( string $find_caps ) : array	Return the users list with a capability
wp_authenticate_user ( WP_User | WP_Error $user )	Filter whether the given user can be authenticated with the provided $password.
wp_login ( string $user_login, WP_User $user = null )	Fires after the user has successfully logged in.
wp_login_failed ( string $username )	Fires after a user login has failed.
wp_logout ( )	Fires after a user is logged-out.

Private Methods

Method	Description
__construct ( ) : WPDKUsers	Return an instance of WPDKUsers class and register the primary hook for manage and enhancer the standard WordPress User.

Method Details