2017-07-26 14:57:52 +03:00
< ? php
namespace um\core ;
// Exit if accessed directly
if ( ! defined ( 'ABSPATH' ) ) exit ;
2018-03-26 01:27:46 +03:00
if ( ! class_exists ( 'um\core\User' ) ) {
2018-03-20 13:24:38 +02:00
/**
* Class User
* @package um\core
*/
class User {
/**
* User constructor.
*/
function __construct () {
$this -> id = 0 ;
$this -> usermeta = null ;
$this -> data = null ;
$this -> profile = null ;
$this -> cannot_edit = null ;
$this -> banned_keys = array (
'metabox' , 'postbox' , 'meta-box' ,
'dismissed_wp_pointers' , 'session_tokens' ,
'screen_layout' , 'wp_user-' , 'dismissed' ,
'cap_key' , 'wp_capabilities' ,
'managenav' , 'nav_menu' , 'user_activation_key' ,
'level_' , 'wp_user_level'
);
add_action ( 'init' , array ( & $this , 'set' ), 1 );
$this -> preview = false ;
2018-05-14 17:55:47 +03:00
$this -> send_mail_on_delete = true ;
2018-03-20 13:24:38 +02:00
// a list of keys that should never be in wp_usermeta
$this -> update_user_keys = array (
'user_email' ,
'user_pass' ,
'user_password' ,
'display_name' ,
2018-03-21 21:15:46 +08:00
'user_url' ,
2018-03-20 13:24:38 +02:00
'role' ,
);
$this -> target_id = null ;
// When the cache should be cleared
2019-08-08 00:36:33 +03:00
add_action ( 'um_delete_user_hook' , array ( & $this , 'remove_cached_queue' ) );
add_action ( 'um_delete_user' , array ( & $this , 'remove_cache' ), 10 , 1 );
2018-05-14 17:55:47 +03:00
2019-08-08 00:36:33 +03:00
add_action ( 'um_after_user_status_is_changed_hook' , array ( & $this , 'remove_cached_queue' ) );
2018-03-20 13:24:38 +02:00
// When user cache should be cleared
2019-08-08 00:36:33 +03:00
add_action ( 'um_after_user_updated' , array ( & $this , 'remove_cache' ) );
add_action ( 'um_after_user_account_updated' , array ( & $this , 'remove_cache' ) );
add_action ( 'personal_options_update' , array ( & $this , 'remove_cache' ) );
2018-03-20 13:24:38 +02:00
//add_action('edit_user_profile_update', array(&$this, 'remove_cache') );
2019-08-08 00:36:33 +03:00
add_action ( 'um_when_role_is_set' , array ( & $this , 'remove_cache' ) );
add_action ( 'um_when_status_is_set' , array ( & $this , 'remove_cache' ) );
2018-03-20 13:24:38 +02:00
add_action ( 'show_user_profile' , array ( $this , 'profile_form_additional_section' ), 10 );
add_action ( 'user_new_form' , array ( $this , 'profile_form_additional_section' ), 10 );
add_action ( 'edit_user_profile' , array ( $this , 'profile_form_additional_section' ), 10 );
add_filter ( 'um_user_profile_additional_fields' , array ( $this , 'secondary_role_field' ), 1 , 2 );
2017-07-26 14:57:52 +03:00
2017-11-06 15:28:07 +02:00
//on every update of user profile (hook from wp_update_user)
2018-03-20 13:24:38 +02:00
add_action ( 'profile_update' , array ( & $this , 'profile_update' ), 10 , 2 ); // user_id and old_user_data
2017-07-26 14:57:52 +03:00
2018-03-20 13:24:38 +02:00
//on user update profile page
//add_action( 'edit_user_profile_update', array( &$this, 'profile_update' ), 10, 1 );
2017-07-26 14:57:52 +03:00
2018-03-20 13:24:38 +02:00
add_action ( 'user_register' , array ( & $this , 'user_register_via_admin' ), 10 , 1 );
add_action ( 'user_register' , array ( & $this , 'set_gravatar' ), 11 , 1 );
2017-11-26 13:16:43 +02:00
2019-05-29 18:51:22 +03:00
if ( is_multisite () ) {
add_action ( 'added_existing_user' , array ( & $this , 'add_um_role_existing_user' ), 10 , 2 );
add_action ( 'wpmu_activate_user' , array ( & $this , 'add_um_role_wpmu_new_user' ), 10 , 1 );
}
2018-01-19 12:50:54 +02:00
2018-03-20 13:24:38 +02:00
add_action ( 'init' , array ( & $this , 'check_membership' ), 10 );
2018-05-14 17:55:47 +03:00
2018-11-21 14:01:18 +02:00
if ( is_multisite () ) {
add_action ( 'wpmu_delete_user' , array ( & $this , 'delete_user_handler' ), 10 , 1 );
2019-01-22 16:34:13 +02:00
} else {
add_action ( 'delete_user' , array ( & $this , 'delete_user_handler' ), 10 , 1 );
2018-11-21 14:01:18 +02:00
}
2018-05-14 17:55:47 +03:00
}
/**
* @param $user_id
*/
function delete_user_handler ( $user_id ) {
um_fetch_user ( $user_id );
/**
* UM hook
*
* @type action
* @title um_delete_user_hook
* @description On delete user
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_delete_user_hook', 'function_name', 10 );
* @example
* <?php
* add_action( 'um_delete_user_hook', 'my_delete_user', 10 );
* function my_delete_user() {
* // your code here
* }
* ?>
*/
do_action ( 'um_delete_user_hook' );
/**
* UM hook
*
* @type action
* @title um_delete_user
* @description On delete user
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_delete_user', 'function_name', 10, 1 );
* @example
* <?php
* add_action( 'um_delete_user', 'my_delete_user', 10, 1 );
* function my_delete_user( $user_id ) {
* // your code here
* }
* ?>
*/
do_action ( 'um_delete_user' , um_user ( 'ID' ) );
// send email notifications
if ( $this -> send_mail_on_delete ) {
UM () -> mail () -> send ( um_user ( 'user_email' ), 'deletion_email' );
$emails = um_multi_admin_email ();
if ( ! empty ( $emails ) ) {
foreach ( $emails as $email ) {
UM () -> mail () -> send ( $email , 'notification_deletion' , array ( 'admin' => true ) );
}
}
}
// remove uploads
2019-01-22 16:34:13 +02:00
UM () -> files () -> remove_dir ( UM () -> files () -> upload_temp );
2018-09-12 16:09:05 +03:00
UM () -> files () -> remove_dir ( UM () -> uploader () -> get_upload_base_dir () . um_user ( 'ID' ) . DIRECTORY_SEPARATOR );
2018-03-20 13:24:38 +02:00
}
2017-07-26 14:57:52 +03:00
2018-03-20 13:24:38 +02:00
/**
*
*/
function check_membership () {
2019-08-08 00:36:33 +03:00
if ( ! is_user_logged_in () ) {
2018-03-20 13:24:38 +02:00
return ;
2019-08-08 00:36:33 +03:00
}
2018-01-19 12:50:54 +02:00
2018-03-20 13:24:38 +02:00
um_fetch_user ( get_current_user_id () );
$status = um_user ( 'account_status' );
2018-01-19 12:50:54 +02:00
2018-03-20 13:24:38 +02:00
if ( 'rejected' == $status ) {
wp_logout ();
session_unset ();
exit ( wp_redirect ( um_get_core_page ( 'login' ) ) );
}
2018-01-19 12:50:54 +02:00
2018-03-20 13:24:38 +02:00
um_reset_user ();
}
2018-01-19 12:50:54 +02:00
2017-11-26 13:16:43 +02:00
/**
* Multisite add existing user
*
* @param $user_id
* @param $result
*/
function add_um_role_existing_user ( $user_id , $result ) {
// Bail if no user ID was passed
2019-05-29 18:51:22 +03:00
if ( empty ( $user_id ) ) {
2017-11-26 13:16:43 +02:00
return ;
2019-05-29 18:51:22 +03:00
}
2017-11-26 13:16:43 +02:00
if ( ! empty ( $_POST [ 'um-role' ] ) ) {
if ( ! user_can ( $user_id , $_POST [ 'um-role' ] ) ) {
UM () -> roles () -> set_role ( $user_id , $_POST [ 'um-role' ] );
}
}
$this -> remove_cache ( $user_id );
}
/**
* Multisite add existing user
*
* @param $user_id
*/
function add_um_role_wpmu_new_user ( $user_id ) {
// Bail if no user ID was passed
2019-08-08 00:36:33 +03:00
if ( empty ( $user_id ) ) {
2017-11-26 13:16:43 +02:00
return ;
2019-08-08 00:36:33 +03:00
}
2017-11-26 13:16:43 +02:00
if ( ! empty ( $_POST [ 'um-role' ] ) ) {
if ( ! user_can ( $user_id , $_POST [ 'um-role' ] ) ) {
UM () -> roles () -> set_role ( $user_id , $_POST [ 'um-role' ] );
}
}
$this -> remove_cache ( $user_id );
}
2018-03-20 13:24:38 +02:00
/**
* Get pending users (in queue)
*/
function get_pending_users_count () {
$cached_users_queue = get_option ( 'um_cached_users_queue' );
if ( $cached_users_queue > 0 && ! isset ( $_REQUEST [ 'delete_count' ] ) ){
return $cached_users_queue ;
}
$args = array ( 'fields' => 'ID' , 'number' => 1 );
$args [ 'meta_query' ][ 'relation' ] = 'OR' ;
$args [ 'meta_query' ][] = array (
'key' => 'account_status' ,
'value' => 'awaiting_email_confirmation' ,
'compare' => '='
);
$args [ 'meta_query' ][] = array (
'key' => 'account_status' ,
'value' => 'awaiting_admin_review' ,
'compare' => '='
);
/**
* UM hook
*
* @type filter
* @title um_admin_pending_queue_filter
* @description Change user query arguments when get pending users
* @input_vars
* [{"var":"$args","type":"array","desc":"WP_Users query arguments"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_admin_pending_queue_filter', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_admin_pending_queue_filter', 'my_admin_pending_queue', 10, 1 );
* function my_admin_pending_queue( $args ) {
* // your code here
* return $args;
* }
* ?>
*/
$args = apply_filters ( 'um_admin_pending_queue_filter' , $args );
$users = new \WP_User_Query ( $args );
delete_option ( 'um_cached_users_queue' );
add_option ( 'um_cached_users_queue' , $users -> get_total (), '' , 'no' );
return $users -> get_total ();
}
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
/**
2018-03-20 13:24:38 +02:00
* @param $user_id
*
* @return bool|mixed
*/
2018-02-18 13:27:46 +02:00
function get_profile_slug ( $user_id ) {
2018-02-12 16:27:34 +02:00
// Permalink base
$permalink_base = UM () -> options () -> get ( 'permalink_base' );
$profile_slug = get_user_meta ( $user_id , " um_user_profile_url_slug_ { $permalink_base } " , true );
2017-07-26 14:57:52 +03:00
2018-02-18 13:27:46 +02:00
//get default username permalink if it's empty then return false
if ( empty ( $profile_slug ) ) {
if ( $permalink_base != 'user_login' ) {
2019-08-08 00:36:33 +03:00
$profile_slug = get_user_meta ( $user_id , 'um_user_profile_url_slug_user_login' , true );
2018-02-18 13:27:46 +02:00
}
if ( empty ( $profile_slug ) ) {
return false ;
}
2018-02-12 16:27:34 +02:00
}
2017-07-26 14:57:52 +03:00
2018-02-18 13:27:46 +02:00
return $profile_slug ;
}
2017-07-26 14:57:52 +03:00
2018-02-18 13:27:46 +02:00
/**
* @param $user_id
*
* @return bool|string
*/
function get_profile_link ( $user_id ) {
$profile_slug = $this -> get_profile_slug ( $user_id );
if ( empty ( $profile_slug ) ) {
return false ;
2018-02-12 16:27:34 +02:00
}
2017-07-26 14:57:52 +03:00
2018-02-18 13:27:46 +02:00
return UM () -> permalinks () -> profile_permalink ( $profile_slug );
}
/**
2018-12-07 14:00:23 +02:00
* Generate User Profile Slug and save to meta
2018-08-08 13:22:08 +03:00
*
* @param int $user_id
* @param bool $force
2018-02-18 13:27:46 +02:00
*/
function generate_profile_slug ( $user_id , $force = false ) {
2018-02-12 16:27:34 +02:00
$userdata = get_userdata ( $user_id );
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
if ( empty ( $userdata ) ) {
2018-02-18 13:27:46 +02:00
return ;
2018-02-12 16:27:34 +02:00
}
2017-07-26 14:57:52 +03:00
2018-02-18 13:27:46 +02:00
delete_option ( " um_cache_userdata_ { $user_id } " );
$current_profile_slug = $this -> get_profile_slug ( $user_id );
2018-02-12 16:27:34 +02:00
$user_in_url = '' ;
2018-02-18 13:27:46 +02:00
$permalink_base = UM () -> options () -> get ( 'permalink_base' );
// User ID
if ( $permalink_base == 'user_id' ) {
$user_in_url = $user_id ;
}
2018-02-12 16:27:34 +02:00
// Username
if ( $permalink_base == 'user_login' ) {
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
$user_in_url = $userdata -> user_login ;
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
if ( is_email ( $user_in_url ) ) {
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
$user_email = $user_in_url ;
$user_in_url = str_replace ( '@' , '' , $user_in_url );
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
if ( ( $pos = strrpos ( $user_in_url , '.' ) ) !== false ) {
$search_length = strlen ( '.' );
$user_in_url = substr_replace ( $user_in_url , '-' , $pos , $search_length );
}
update_user_meta ( $user_id , " um_email_as_username_ { $user_in_url } " , $user_email );
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
} else {
2017-07-26 14:57:52 +03:00
2018-12-07 14:00:23 +02:00
$user_in_url = urlencode ( $user_in_url );
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
}
}
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
// Fisrt and Last name
$full_name_permalinks = array ( 'name' , 'name_dash' , 'name_plus' );
if ( in_array ( $permalink_base , $full_name_permalinks ) ) {
$separated = array ( 'name' => '.' , 'name_dash' => '-' , 'name_plus' => '+' );
$separate = $separated [ $permalink_base ];
$first_name = $userdata -> first_name ;
$last_name = $userdata -> last_name ;
2018-02-13 11:28:54 +02:00
$full_name = trim ( sprintf ( '%s %s' , $first_name , $last_name ) );
2018-02-12 16:27:34 +02:00
$full_name = preg_replace ( '/\s+/' , ' ' , $full_name ); // Remove double spaces
$profile_slug = UM () -> permalinks () -> profile_slug ( $full_name , $first_name , $last_name );
2018-02-18 13:27:46 +02:00
$append = 0 ;
$username = $full_name ;
$_username = $full_name ;
2018-02-12 16:27:34 +02:00
2018-02-18 13:27:46 +02:00
while ( 1 ) {
$username = $_username . ( empty ( $append ) ? '' : " $append " );
$slug_exists_user_id = UM () -> permalinks () -> slug_exists_user_id ( $profile_slug . ( empty ( $append ) ? '' : " { $separate } { $append } " ) );
if ( empty ( $slug_exists_user_id ) || $user_id == $slug_exists_user_id ) {
break ;
2018-02-12 16:27:34 +02:00
}
2018-02-18 13:27:46 +02:00
$append ++ ;
2018-02-12 16:27:34 +02:00
}
2018-02-13 11:21:40 +02:00
2018-02-12 16:27:34 +02:00
$user_in_url = UM () -> permalinks () -> profile_slug ( $username , $first_name , $last_name );
2018-02-18 13:27:46 +02:00
if ( empty ( $user_in_url ) ) {
2018-02-13 11:21:40 +02:00
$user_in_url = $userdata -> user_login ;
2017-07-26 14:57:52 +03:00
2018-02-18 13:27:46 +02:00
if ( is_email ( $user_in_url ) ) {
2017-07-26 14:57:52 +03:00
2018-02-18 13:27:46 +02:00
$user_email = $user_in_url ;
$user_in_url = str_replace ( '@' , '' , $user_in_url );
if ( ( $pos = strrpos ( $user_in_url , '.' ) ) !== false ) {
$search_length = strlen ( '.' );
$user_in_url = substr_replace ( $user_in_url , '-' , $pos , $search_length );
}
update_user_meta ( $user_id , " um_email_as_username_ { $user_in_url } " , $user_email );
} else {
$user_in_url = sanitize_title ( $user_in_url );
}
}
$user_in_url = trim ( $user_in_url , $separate );
2018-02-12 16:27:34 +02:00
}
2018-01-23 17:12:33 +02:00
2018-08-08 13:22:08 +03:00
$user_in_url = apply_filters ( 'um_change_user_profile_slug' , $user_in_url , $user_id );
2018-02-18 13:27:46 +02:00
if ( $force || empty ( $current_profile_slug ) || $current_profile_slug != $user_in_url ) {
update_user_meta ( $user_id , " um_user_profile_url_slug_ { $permalink_base } " , $user_in_url );
}
2018-02-12 16:27:34 +02:00
}
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
/**
2018-03-20 13:24:38 +02:00
* Backend user creation
*
* @param $user_id
*/
2018-02-12 16:27:34 +02:00
function user_register_via_admin ( $user_id ) {
2017-07-26 14:57:52 +03:00
2019-05-29 18:51:22 +03:00
if ( empty ( $user_id ) ) {
2018-02-12 16:27:34 +02:00
return ;
2019-05-29 18:51:22 +03:00
}
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
if ( is_admin () ) {
//if there custom 2 role not empty
if ( ! empty ( $_POST [ 'um-role' ] ) ) {
$user = get_userdata ( $user_id );
$user -> add_role ( $_POST [ 'um-role' ] );
UM () -> user () -> profile [ 'role' ] = $_POST [ 'um-role' ];
UM () -> user () -> update_usermeta_info ( 'role' );
}
2017-07-26 14:57:52 +03:00
2018-03-05 16:35:51 +02:00
/**
* UM hook
*
* @type action
* @title um_user_register
* @description Action on user registration
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"},
* {"var":"$submitted","type":"array","desc":"Registration form submitted"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_user_register', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_user_register', 'my_user_register', 10, 2 );
* function my_user_register( $user_id, $submitted ) {
* // your code here
* }
* ?>
*/
2018-02-12 16:27:34 +02:00
do_action ( 'um_user_register' , $user_id , $_POST );
}
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
}
2017-07-26 14:57:52 +03:00
2017-11-06 15:28:07 +02:00
/**
2018-03-20 13:24:38 +02:00
* On wp_update_user function complete
*
* @param int $user_id
* @param \WP_User $old_data
*/
2018-02-12 16:27:34 +02:00
function profile_update ( $user_id , $old_data ) {
// Bail if no user ID was passed
if ( empty ( $user_id ) ) {
return ;
}
2017-07-26 14:57:52 +03:00
2018-02-12 16:27:34 +02:00
$old_roles = $old_data -> roles ;
$userdata = get_userdata ( $user_id );
$new_roles = $userdata -> roles ;
2017-11-06 15:28:07 +02:00
2019-05-29 18:51:22 +03:00
if ( is_admin () ) {
if ( ! empty ( $_POST [ 'um-role' ] ) ) {
$new_roles = array_merge ( $new_roles , array ( $_POST [ 'um-role' ] ) );
if ( ! user_can ( $user_id , $_POST [ 'um-role' ] ) ) {
UM () -> roles () -> set_role ( $user_id , $_POST [ 'um-role' ] );
}
2018-02-12 16:27:34 +02:00
}
}
2017-11-06 15:28:07 +02:00
2018-03-05 16:35:51 +02:00
/**
* UM hook
*
* @type action
* @title um_after_member_role_upgrade
* @description Action on user registration
* @input_vars
* [{"var":"$new_roles","type":"array","desc":"User new roles"},
* {"var":"$old_roles","type":"array","desc":"Old roles"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_member_role_upgrade', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_after_member_role_upgrade', 'my_after_member_role_upgrade', 10, 2 );
* function my_after_member_role_upgrade( $new_roles, $old_roles ) {
* // your code here
* }
* ?>
*/
2019-01-24 19:20:29 +02:00
do_action ( 'um_after_member_role_upgrade' , $new_roles , $old_roles , $user_id );
2018-02-12 13:31:54 +02:00
2018-02-12 16:27:34 +02:00
//Update permalink
2018-02-18 13:27:46 +02:00
$this -> generate_profile_slug ( $user_id , true );
2018-02-12 13:31:54 +02:00
2018-02-12 16:27:34 +02:00
$this -> remove_cache ( $user_id );
}
2017-11-06 15:28:07 +02:00
/**
* Additional section for WP Profile page with UM data fields
*
* @param \WP_User $userdata User data
* @return void
*/
function profile_form_additional_section ( $userdata ) {
2018-03-02 09:55:49 +02:00
/**
* UM hook
*
* @type filter
* @title um_user_profile_additional_fields
* @description Make additional content section
* @input_vars
* [{"var":"$content","type":"array","desc":"Additional section content"},
* {"var":"$userdata","type":"array","desc":"Userdata"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_user_profile_additional_fields', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_user_profile_additional_fields', 'my_admin_pending_queue', 10, 2 );
* function my_admin_pending_queue( $content, $userdata ) {
* // your code here
* return $content;
* }
* ?>
*/
2017-11-06 15:28:07 +02:00
$section_content = apply_filters ( 'um_user_profile_additional_fields' , '' , $userdata );
2017-11-26 13:16:43 +02:00
if ( ! empty ( $section_content ) && ! ( is_multisite () && is_network_admin () ) ) {
2017-11-06 15:28:07 +02:00
2017-11-17 14:14:51 +02:00
if ( $userdata !== 'add-new-user' && $userdata !== 'add-existing-user' ) { ?>
2017-11-06 15:28:07 +02:00
<h3><?php esc_html_e( 'Ultimate Member', 'ultimate-member' ); ?></h3>
<?php }
echo $section_content;
}
}
2017-07-26 14:57:52 +03:00
2018-03-20 13:24:38 +02:00
/**
* Default interface for setting a ultimatemember role
*
* @param string $content Section HTML
* @param \WP_User $userdata User data
* @return string
*/
public function secondary_role_field( $content, $userdata ) {
$roles = array();
$role_keys = get_option( 'um_roles' );
if ( $role_keys ) {
foreach ( $role_keys as $role_key ) {
$role_meta = get_option( "um_role_{$role_key}_meta" );
if ( $role_meta ) {
2019-08-08 00:36:33 +03:00
$roles[ 'um_' . $role_key ] = $role_meta;
2018-03-20 13:24:38 +02:00
}
}
}
2019-08-08 00:36:33 +03:00
if ( empty( $roles ) ) {
2018-03-20 13:24:38 +02:00
return $content;
2019-08-08 00:36:33 +03:00
}
2018-03-20 13:24:38 +02:00
global $pagenow;
2019-08-08 00:36:33 +03:00
if ( 'profile.php' == $pagenow ) {
2018-03-20 13:24:38 +02:00
return $content;
2019-08-08 00:36:33 +03:00
}
2018-03-20 13:24:38 +02:00
$style = '';
$user_role = false;
if ( $userdata !== 'add-new-user' && $userdata !== 'add-existing-user' ) {
// Bail if current user cannot edit users
2019-08-08 00:36:33 +03:00
if ( ! current_user_can( 'edit_user', $userdata->ID ) ) {
2018-03-20 13:24:38 +02:00
return $content;
2019-08-08 00:36:33 +03:00
}
2018-03-20 13:24:38 +02:00
$user_role = UM()->roles()->get_um_user_role( $userdata->ID );
2019-08-08 00:36:33 +03:00
if ( $user_role && ! empty( $userdata->roles ) && count( $userdata->roles ) == 1 ) {
2018-03-20 13:24:38 +02:00
$style = 'style="display:none;"';
2019-08-08 00:36:33 +03:00
}
2018-03-20 13:24:38 +02:00
}
$class = ( $userdata == 'add-existing-user' ) ? 'um_role_existing_selector_wrapper' : 'um_role_selector_wrapper';
ob_start(); ?>
2019-08-08 00:36:33 +03:00
<div id="<?php echo esc_attr( $class ) ?>" <?php echo $style ?>>
2018-03-20 13:24:38 +02:00
<table class="form-table">
<tbody>
<tr>
<th><label for="um-role"><?php esc_html_e( 'Ultimate Member Role', 'ultimate-member' ); ?></label></th>
<td>
<select name="um-role" id="um-role">
<option value="" <?php selected( empty( $user_role ) ) ?>><?php esc_html_e( '— No role for Ultimate Member —', 'ultimate-member' ); ?></option>
<?php foreach ( $roles as $role_id => $details ) { ?>
2019-08-08 00:36:33 +03:00
<option <?php selected( $user_role, $role_id ); ?> value="<?php echo esc_attr( $role_id ); ?>"><?php echo esc_html( $details['name'] ); ?></option>
2018-03-20 13:24:38 +02:00
<?php } ?>
</select>
</td>
</tr>
</tbody>
</table>
</div>
2017-07-26 14:57:52 +03:00
2017-11-06 15:28:07 +02:00
<?php $content .= ob_get_clean();
2017-07-26 14:57:52 +03:00
2018-03-20 13:24:38 +02:00
return $content;
}
/**
* Remove cached queue from Users backend
*/
function remove_cached_queue() {
delete_option( 'um_cached_users_queue' );
}
/**
* Converts object to array
*
* @param $obj
*
* @return array
*/
function toArray( $obj ) {
2019-08-08 00:36:33 +03:00
if ( is_object( $obj ) ) {
$obj = (array) $obj;
}
2018-03-20 13:24:38 +02:00
if ( is_array( $obj ) ) {
$new = array();
foreach ( $obj as $key => $val ) {
$new[ $key ] = $this->toArray( $val );
}
} else {
$new = $obj;
}
return $new;
}
/**
* @param $user_id
*
2019-08-08 00:36:33 +03:00
* @return mixed|string
2018-03-20 13:24:38 +02:00
*/
function get_cached_data( $user_id ) {
$disallow_cache = UM()->options()->get( 'um_profile_object_cache_stop' );
2019-08-08 00:36:33 +03:00
if ( $disallow_cache ) {
2018-03-20 13:24:38 +02:00
return '';
}
if ( is_numeric( $user_id ) && $user_id > 0 ) {
2019-08-08 00:36:33 +03:00
$find_user = get_option( "um_cache_userdata_{$user_id}" );
2018-03-20 13:24:38 +02:00
if ( $find_user ) {
/**
* UM hook
*
* @type filter
* @title um_user_permissions_filter
* @description Change User Permissions
* @input_vars
* [{"var":"$permissions","type":"array","desc":"User Permissions"},
* {"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_user_permissions_filter', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_user_permissions_filter', 'my_user_permissions', 10, 2 );
* function my_user_permissions( $permissions, $user_id ) {
* // your code here
* return $permissions;
* }
* ?>
*/
$find_user = apply_filters( 'um_user_permissions_filter', $find_user, $user_id );
return $find_user;
}
}
return '';
}
/**
* @param $user_id
* @param $profile
*/
function setup_cache( $user_id, $profile ) {
$disallow_cache = UM()->options()->get( 'um_profile_object_cache_stop' );
if ( $disallow_cache ) {
return;
}
update_option( "um_cache_userdata_{$user_id}", $profile, false );
}
/**
* @param $user_id
*/
function remove_cache( $user_id ) {
delete_option( "um_cache_userdata_{$user_id}" );
}
2018-04-05 14:38:20 +03:00
/**
* Remove cache for all users
*/
function remove_cache_all_users() {
global $wpdb;
$wpdb->query( "DELETE FROM {$wpdb->options} WHERE option_name LIKE 'um_cache_userdata_%'" );
}
2018-03-20 13:24:38 +02:00
/**
* This method lets you set a user. For example, to retrieve a profile or anything related to that user.
*
* @usage <?php UM()->user()->set( $user_id, $clean = false ); ?>
*
* @param null|int $user_id Which user to retrieve. A numeric user ID
* @param bool $clean Should be true or false. Basically, if you did not provide a user ID It will set the current logged in user as a profile
*
* @example The following example makes you set a user and retrieve their display name after that using the user API.
<?php
UM()->user()->set( 12 );
$display_name = UM()->user()->profile['display_name']; // Should print user display name
?>
*
*/
function set( $user_id = null, $clean = false ) {
if ( isset( $this->profile ) ) {
unset( $this->profile );
}
if ( $user_id ) {
$this->id = $user_id;
} elseif ( is_user_logged_in() && $clean == false ) {
$this->id = get_current_user_id();
} else {
$this->id = 0;
}
if ( $this->get_cached_data( $this->id ) ) {
$this->profile = $this->get_cached_data( $this->id );
} else {
if ( $user_id ) {
$this->id = $user_id;
$this->usermeta = get_user_meta( $user_id );
$this->data = get_userdata( $this->id );
} elseif ( is_user_logged_in() && $clean == false ) {
$this->id = get_current_user_id();
$this->usermeta = get_user_meta($this->id);
$this->data = get_userdata($this->id);
} else {
$this->id = 0;
$this->usermeta = null;
$this->data = null;
}
// we have a user, populate a profile
if ( $this->id && $this->toArray( $this->data ) ) {
// add user data
$this->data = $this->toArray( $this->data );
foreach ( $this->data as $k=>$v ) {
if ( $k == 'roles') {
$this->profile['wp_roles'] = implode(',',$v);
} else if ( is_array( $v ) ) {
foreach($v as $k2 => $v2){
$this->profile[$k2] = $v2;
}
} else {
$this->profile[$k] = $v;
}
}
// add account status
if ( !isset( $this->usermeta['account_status'][0] ) ) {
$this->usermeta['account_status'][0] = 'approved';
}
if ( $this->usermeta['account_status'][0] == 'approved' ) {
$this->usermeta['account_status_name'][0] = __('Approved','ultimate-member');
}
if ( $this->usermeta['account_status'][0] == 'awaiting_email_confirmation' ) {
$this->usermeta['account_status_name'][0] = __('Awaiting E-mail Confirmation','ultimate-member');
}
if ( $this->usermeta['account_status'][0] == 'awaiting_admin_review' ) {
$this->usermeta['account_status_name'][0] = __('Pending Review','ultimate-member');
}
if ( $this->usermeta['account_status'][0] == 'rejected' ) {
$this->usermeta['account_status_name'][0] = __('Membership Rejected','ultimate-member');
}
if ( $this->usermeta['account_status'][0] == 'inactive' ) {
$this->usermeta['account_status_name'][0] = __('Membership Inactive','ultimate-member');
}
// add user meta
2019-05-15 12:30:14 +03:00
foreach ( $this->usermeta as $k => $v ) {
2019-04-15 18:26:26 +03:00
if ( $k == 'display_name') {
continue;
}
2019-05-15 12:30:14 +03:00
$this->profile[ $k ] = $v[0];
2018-03-20 13:24:38 +02:00
}
// add permissions
$user_role = UM()->roles()->get_priority_user_role( $this->id );
$this->profile['role'] = $user_role;
$this->profile['roles'] = UM()->roles()->get_all_user_roles( $this->id );
$role_meta = UM()->roles()->role_data( $user_role );
/**
* UM hook
*
* @type filter
* @title um_user_permissions_filter
* @description Change User Permissions
* @input_vars
* [{"var":"$permissions","type":"array","desc":"User Permissions"},
* {"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_user_permissions_filter', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_user_permissions_filter', 'my_user_permissions', 10, 2 );
* function my_user_permissions( $permissions, $user_id ) {
* // your code here
* return $permissions;
* }
* ?>
*/
$role_meta = apply_filters( 'um_user_permissions_filter', $role_meta, $this->id );
/*$role_meta = array_map( function( $key, $item ) {
2017-07-26 14:57:52 +03:00
if ( strpos( $key, '_um_' ) === 0 )
$key = str_replace( '_um_', '', $key );
return array( $key => $item );
}, array_keys( $role_meta ), $role_meta );*/
2018-03-20 13:24:38 +02:00
$this->profile = array_merge( $this->profile, (array)$role_meta );
$this->profile['super_admin'] = ( is_super_admin( $this->id ) ) ? 1 : 0;
// clean profile
$this->clean();
// Setup cache
$this->setup_cache( $this->id, $this->profile );
}
}
}
/**
* Reset user data
*
* @param bool $clean
*/
function reset( $clean = false ){
$this->set(0, $clean);
}
/**
* Clean user profile
*/
function clean() {
2019-08-08 00:36:33 +03:00
foreach ( $this->profile as $key => $value ) {
foreach ( $this->banned_keys as $ban ) {
if ( strstr( $key, $ban ) || is_numeric( $key ) ) {
unset( $this->profile[ $key ] );
}
2018-03-20 13:24:38 +02:00
}
}
}
/**
* This method lets you auto sign-in a user to your site.
*
* @usage <?php UM()->user()->auto_login( $user_id, $rememberme = false ); ?>
*
* @param int $user_id Which user ID to sign in automatically
* @param int|bool $rememberme Should be true or false. If you want the user sign in session to use cookies, use true
*
* @example The following example lets you sign in a user automatically by their ID.
<?php UM()->user()->auto_login( 2 ); ?>
*
*
* @example The following example lets you sign in a user automatically by their ID and makes the plugin remember their session.
<?php UM()->user()->auto_login( 10, true ); ?>
*
*/
function auto_login( $user_id, $rememberme = 0 ) {
wp_set_current_user( $user_id );
wp_set_auth_cookie( $user_id, $rememberme );
2019-08-08 00:36:33 +03:00
$user = get_user_by( 'ID', $user_id );
2018-03-20 13:24:38 +02:00
do_action( 'wp_login', $user->user_login, $user );
}
/**
* Set user's registration details
*
2019-05-08 16:05:27 +03:00
* @param array $submitted
* @param array $args
2018-03-20 13:24:38 +02:00
*/
2019-05-08 16:05:27 +03:00
function set_registration_details( $submitted, $args ) {
2018-03-20 13:24:38 +02:00
if ( isset( $submitted['user_pass'] ) ) {
unset( $submitted['user_pass'] );
}
if ( isset( $submitted['user_password'] ) ) {
unset( $submitted['user_password'] );
}
if ( isset( $submitted['confirm_user_password'] ) ) {
unset( $submitted['confirm_user_password'] );
}
2018-05-14 11:09:27 +03:00
//remove all password field values from submitted details
$password_fields = array();
foreach ( $submitted as $k => $v ) {
if ( UM()->fields()->get_field_type( $k ) == 'password' ) {
$password_fields[] = $k;
$password_fields[] = 'confirm_' . $k;
}
}
foreach ( $password_fields as $pw_field ) {
unset( $submitted[ $pw_field ] );
}
2018-03-20 13:24:38 +02:00
/**
* UM hook
*
* @type filter
* @title um_before_save_filter_submitted
* @description Change submitted data before save usermeta "submitted" on registration process
* @input_vars
2019-05-08 16:05:27 +03:00
* [{"var":"$submitted","type":"array","desc":"Submitted data"},
* {"var":"$args","type":"array","desc":"Form Args"}]
2018-03-20 13:24:38 +02:00
* @change_log
* ["Since: 2.0"]
* @usage
2019-05-08 16:05:27 +03:00
* <?php add_filter( 'um_before_save_filter_submitted', 'function_name', 10, 2 ); ?>
2018-03-20 13:24:38 +02:00
* @example
* <?php
2019-05-08 16:05:27 +03:00
* add_filter( 'um_before_save_filter_submitted', 'my_before_save_filter_submitted', 10, 2 );
* function my_before_save_filter_submitted( $submitted, $args ) {
2018-03-20 13:24:38 +02:00
* // your code here
* return $submitted;
* }
* ?>
*/
2019-05-08 16:05:27 +03:00
$submitted = apply_filters( 'um_before_save_filter_submitted', $submitted, $args );
2018-03-20 13:24:38 +02:00
/**
* UM hook
*
* @type action
* @title um_before_save_registration_details
* @description Action on user registration before save details
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"},
* {"var":"$submitted","type":"array","desc":"Registration form submitted"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_before_save_registration_details', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_before_save_registration_details', 'my_before_save_registration_details', 10, 2 );
* function my_before_save_registration_details( $user_id, $submitted ) {
* // your code here
* }
* ?>
*/
do_action( 'um_before_save_registration_details', $this->id, $submitted );
update_user_meta( $this->id, 'submitted', $submitted );
$this->update_profile( $submitted );
/**
* UM hook
*
* @type action
* @title um_after_save_registration_details
* @description Action on user registration after save details
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"},
* {"var":"$submitted","type":"array","desc":"Registration form submitted"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_save_registration_details', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_after_save_registration_details', 'my_after_save_registration_details', 10, 2 );
* function my_after_save_registration_details( $user_id, $submitted ) {
* // your code here
* }
* ?>
*/
do_action( 'um_after_save_registration_details', $this->id, $submitted );
}
/**
* Set last login for new registered users
*/
function set_last_login() {
update_user_meta( $this->id, '_um_last_login', current_time( 'timestamp' ) );
}
/**
* Set user's account status
*
* @param $status
*/
function set_status( $status ) {
/**
* UM hook
*
* @type action
* @title um_when_status_is_set
* @description Action on user status changed
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_when_status_is_set', 'function_name', 10, 1 );
* @example
* <?php
* add_action( 'um_when_status_is_set', 'my_when_status_is_set', 10, 1 );
* function my_when_status_is_set( $user_id ) {
* // your code here
* }
* ?>
*/
do_action( 'um_when_status_is_set', um_user( 'ID' ) );
$this->profile['account_status'] = $status;
$this->update_usermeta_info( 'account_status' );
/**
* UM hook
*
* @type action
* @title um_after_user_status_is_changed_hook
* @description Action after user status changed
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_user_status_is_changed_hook', 'function_name', 10 );
* @example
* <?php
* add_action( 'um_after_user_status_is_changed_hook', 'my_after_user_status_is_changed', 10 );
* function my_after_user_status_is_changed() {
* // your code here
* }
* ?>
*/
do_action( 'um_after_user_status_is_changed_hook' );
/**
* UM hook
*
* @type action
* @title um_after_user_status_is_changed
* @description Action after user status changed
* @input_vars
* [{"var":"$status","type":"string","desc":"User Status"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_user_status_is_changed', 'function_name', 10, 1 );
* @example
* <?php
* add_action( 'um_after_user_status_is_changed', 'my_after_user_status_is_changed', 10, 1 );
* function my_after_user_status_is_changed( $status ) {
* // your code here
* }
* ?>
*/
do_action( 'um_after_user_status_is_changed', $status );
}
/**
* Set user's hash
*/
function assign_secretkey() {
/**
* UM hook
*
* @type action
* @title um_before_user_hash_is_changed
* @description Action before user hash is changed
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_before_user_hash_is_changed', 'function_name', 10 );
* @example
* <?php
* add_action( 'um_before_user_hash_is_changed', 'my_before_user_hash_is_changed', 10 );
* function my_before_user_hash_is_changed() {
* // your code here
* }
* ?>
*/
do_action( 'um_before_user_hash_is_changed' );
$this->profile['account_secret_hash'] = UM()->validation()->generate();
$this->update_usermeta_info( 'account_secret_hash' );
/**
* UM hook
*
* @type action
* @title um_after_user_hash_is_changed
* @description Action after user hash is changed
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_user_hash_is_changed', 'function_name', 10 );
* @example
* <?php
* add_action( 'um_after_user_hash_is_changed', 'my_after_user_hash_is_changed', 10 );
* function my_after_user_hash_is_changed() {
* // your code here
* }
* ?>
*/
do_action( 'um_after_user_hash_is_changed' );
}
/**
* Password reset email
*/
function password_reset() {
2019-08-08 00:36:33 +03:00
$userdata = get_userdata( um_user( 'ID' ) );
2018-09-16 00:26:32 +03:00
get_password_reset_key( $userdata );
2019-05-06 17:22:57 +03:00
add_filter( 'um_template_tags_patterns_hook', array( UM()->password(), 'add_placeholder' ), 10, 1 );
add_filter( 'um_template_tags_replaces_hook', array( UM()->password(), 'add_replace_placeholder' ), 10, 1 );
2019-08-08 00:36:33 +03:00
UM()->mail()->send( um_user( 'user_email' ), 'resetpw_email' );
2018-03-20 13:24:38 +02:00
}
/**
* Password changed email
*/
2019-08-08 00:36:33 +03:00
function password_changed() {
UM()->mail()->send( um_user( 'user_email' ), 'changedpw_email' );
2018-03-20 13:24:38 +02:00
}
/**
* This method approves a user membership and sends them an optional welcome/approval e-mail.
*
* @usage <?php UM()->user()->approve(); ?>
*
* @example Approve a pending user and allow him to sign-in to your site.
<?php
um_fetch_user( 352 );
UM()->user()->approve();
?>
*
*/
2018-10-04 18:46:03 +03:00
function approve( $repeat = true ) {
2018-03-20 13:24:38 +02:00
$user_id = um_user('ID');
2018-09-17 20:44:07 +03:00
2018-10-04 18:46:03 +03:00
if ( ! $repeat ) {
$status = get_user_meta( $user_id, 'account_status', true );
if ( 'approved' === $status ) {
return;
}
2018-09-17 20:44:07 +03:00
}
2018-03-20 13:24:38 +02:00
delete_option( "um_cache_userdata_{$user_id}" );
2019-08-08 00:36:33 +03:00
if ( um_user( 'account_status' ) == 'awaiting_admin_review' ) {
2018-09-16 00:26:32 +03:00
$userdata = get_userdata( $user_id );
get_password_reset_key( $userdata );
2019-08-08 00:36:33 +03:00
UM()->mail()->send( um_user( 'user_email' ), 'approved_email' );
2018-03-20 13:24:38 +02:00
} else {
2018-09-16 00:26:32 +03:00
$userdata = get_userdata( $user_id );
get_password_reset_key( $userdata );
2019-08-08 00:36:33 +03:00
UM()->mail()->send( um_user( 'user_email' ), 'welcome_email' );
2018-03-20 13:24:38 +02:00
}
2019-08-08 00:36:33 +03:00
$this->set_status( 'approved' );
$this->delete_meta( 'account_secret_hash' );
2018-03-20 13:24:38 +02:00
/**
* UM hook
*
* @type action
* @title um_after_user_is_approved
* @description Action after user was approved
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_user_is_approved', 'function_name', 10, 1 );
* @example
* <?php
* add_action( 'um_after_user_is_approved', 'my_after_user_is_approved', 10, 1 );
* function my_after_user_hash_is_changed( $user_id ) {
* // your code here
* }
* ?>
*/
do_action( 'um_after_user_is_approved', um_user( 'ID' ) );
}
/**
* Pending email
*/
function email_pending() {
$this->assign_secretkey();
2019-08-08 00:36:33 +03:00
$this->set_status( 'awaiting_email_confirmation' );
UM()->mail()->send( um_user( 'user_email' ), 'checkmail_email' );
2018-03-20 13:24:38 +02:00
}
/**
* This method puts a user under manual review by administrator and sends them an optional e-mail.
*
* @usage <?php UM()->user()->pending(); ?>
*
* @example An example of putting a user pending manual review
<?php
um_fetch_user( 54 );
UM()->user()->pending();
?>
*
*/
function pending() {
$this->set_status( 'awaiting_admin_review' );
UM()->mail()->send( um_user( 'user_email' ), 'pending_email' );
}
/**
* This method rejects a user membership and sends them an optional e-mail.
*
* @usage <?php UM()->user()->reject(); ?>
*
* @example Reject a user membership example
<?php
um_fetch_user( 114 );
UM()->user()->reject();
?>
*
*/
function reject() {
2019-08-08 00:36:33 +03:00
$this->set_status( 'rejected' );
UM()->mail()->send( um_user( 'user_email' ), 'rejected_email' );
2018-03-20 13:24:38 +02:00
}
/**
* This method deactivates a user membership and sends them an optional e-mail.
*
* @usage <?php UM()->user()->deactivate(); ?>
*
* @example Deactivate a user membership with the following example
<?php
um_fetch_user( 32 );
$ultimatemember->user->deactivate();
?>
*
*/
function deactivate() {
$this->set_status( 'inactive' );
/**
* UM hook
*
* @type action
* @title um_after_user_is_inactive
* @description Action after user was inactive
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_user_is_inactive', 'function_name', 10, 1 );
* @example
* <?php
* add_action( 'um_after_user_is_inactive', 'my_after_user_is_inactive', 10, 1 );
* function my_after_user_is_inactive( $user_id ) {
* // your code here
* }
* ?>
*/
do_action( 'um_after_user_is_inactive', um_user( 'ID' ) );
UM()->mail()->send( um_user( 'user_email' ), 'inactive_email' );
}
/**
* Delete user
*
* @param bool $send_mail
*/
function delete( $send_mail = true ) {
2018-05-14 17:55:47 +03:00
$this->send_mail_on_delete = $send_mail;
2018-05-30 18:47:08 +03:00
//don't send email notification to not approved user
if ( 'approved' != um_user( 'account_status' ) ) {
$this->send_mail_on_delete = false;
}
2018-03-20 13:24:38 +02:00
// remove user
if ( is_multisite() ) {
2018-04-02 23:04:39 +03:00
if ( ! function_exists( 'wpmu_delete_user' ) ) {
2018-03-20 13:24:38 +02:00
require_once( ABSPATH . 'wp-admin/includes/ms.php' );
}
wpmu_delete_user( $this->id );
} else {
2018-04-02 23:04:39 +03:00
if ( ! function_exists( 'wp_delete_user' ) ) {
2018-03-20 13:24:38 +02:00
require_once( ABSPATH . 'wp-admin/includes/user.php' );
}
wp_delete_user( $this->id );
}
}
/**
* This method gets a user role in slug format. e.g. member
*
* @usage <?php UM()->user()->get_role(); ?>
*
* @return string
*
* @example Do something if the user's role is paid-member
<?php
um_fetch_user( 12 );
if ( UM()->user()->get_role() == 'paid-member' ) {
// Show this to paid customers
} else {
// You are a free member
}
?>
*
*/
function get_role() {
if ( ! empty( $this->profile['role'] ) ) {
return $this->profile['role'];
} else {
if ( $this->profile['wp_roles'] == 'administrator' ) {
return 'admin';
} else {
return 'member';
}
}
}
/**
* Update one key in user meta
*
* @param $key
*/
function update_usermeta_info( $key ) {
// delete the key first just in case
delete_user_meta( $this->id, $key );
2019-08-08 00:36:33 +03:00
update_user_meta( $this->id, $key, $this->profile[ $key ] );
2018-03-20 13:24:38 +02:00
}
/**
* This method can be used to delete user's meta key.
*
* @usage <?php UM()->user()->delete_meta( $key ); ?>
*
* @param string $key The meta field key to remove from user
*
* @example Delete user's age field
<?php
um_fetch_user( 15 );
UM()->user()->delete_meta( 'age' );
?>
*
*/
2019-08-08 00:36:33 +03:00
function delete_meta( $key ) {
2018-03-20 13:24:38 +02:00
delete_user_meta( $this->id, $key );
}
/**
* Get admin actions for individual user
*
* @return array|bool
*/
function get_admin_actions() {
$items = array();
2018-06-03 17:45:21 +03:00
2018-03-20 13:24:38 +02:00
/**
* UM hook
*
* @type filter
* @title um_admin_user_actions_hook
* @description Extend admin actions for each user
* @input_vars
* [{"var":"$actions","type":"array","desc":"Actions for user"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_admin_user_actions_hook', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_admin_user_actions_hook', 'my_admin_user_actions', 10, 1 );
* function my_admin_user_actions( $actions ) {
* // your code here
* return $actions;
* }
* ?>
*/
2019-11-12 15:22:19 +02:00
$actions = apply_filters( 'um_admin_user_actions_hook', array(), um_profile_id() );
if ( empty( $actions ) ) {
return $items;
2018-06-03 17:45:21 +03:00
}
foreach ( $actions as $id => $arr ) {
$url = add_query_arg( array( 'um_action' => $id, 'uid' => um_profile_id() ) );
/*$url = add_query_arg( 'um_action', $id );
$url = add_query_arg( 'uid', um_profile_id(), $url );*/
2019-08-08 00:36:33 +03:00
$items[] = '<a href="' . esc_url( $url ) .'" class="real_url ' . esc_attr( $id ) . '-item">' . esc_html( $arr['label'] ) . '</a>';
2018-03-20 13:24:38 +02:00
}
return $items;
}
/**
* This method checks if give user profile is private.
*
* @usage <?php UM()->user()->is_private_profile( $user_id ); ?>
*
* @param int $user_id A user ID must be passed to check if the user profile is private
*
* @return bool
*
* @example This example display a specific user's name If his profile is public
<?php
um_fetch_user( 60 );
$is_private = UM()->user()->is_private_profile( 60 );
if ( ! $is_private ) {
echo 'User is public and his name is ' . um_user('display_name');
}
?>
*
*/
function is_private_profile( $user_id ) {
$privacy = get_user_meta( $user_id, 'profile_privacy', true );
2019-08-08 00:36:33 +03:00
if ( $privacy == __( 'Only me', 'ultimate-member' ) || $privacy == 'Only me' ) {
2018-03-20 13:24:38 +02:00
return true;
}
return false;
}
/**
* This method can be used to determine If a certain user is approved or not.
*
* @usage <?php UM()->user()->is_approved( $user_id ); ?>
*
* @param int $user_id The user ID to check approval status for
*
* @return bool
*
* @example Do something If a user's membership is approved
<?php
if ( UM()->user()->is_approved( 55 ) {
// User account is approved
} else {
// User account is not approved
}
?>
*
*/
function is_approved( $user_id ) {
$status = get_user_meta( $user_id, 'account_status', true );
if ( $status == 'approved' || $status == '' ) {
return true;
}
return false;
}
/**
* Is private
*
* @param $user_id
* @param $case
*
2018-07-30 17:33:59 +03:00
* @return bool
2018-03-20 13:24:38 +02:00
*/
function is_private_case( $user_id, $case ) {
$privacy = get_user_meta( $user_id, 'profile_privacy', true );
if ( $privacy == $case ) {
/**
* UM hook
*
* @type filter
* @title um_is_private_filter_hook
* @description Change user privacy
* @input_vars
* [{"var":"$is_private","type":"bool","desc":"Is user private"},
* {"var":"$privacy","type":"bool","desc":"Profile Privacy"},
* {"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_is_private_filter_hook', 'function_name', 10, 3 ); ?>
* @example
* <?php
* add_filter( 'um_is_private_filter_hook', 'my_is_private_filter', 10, 3 );
* function my_is_private_filter( $is_private ) {
* // your code here
* return $is_private;
* }
* ?>
*/
$bool = apply_filters( 'um_is_private_filter_hook', false, $privacy, $user_id );
return $bool;
}
return false;
}
/**
* Update files
*
* @param $changes
2019-10-21 23:39:19 +03:00
*
* @deprecated 2.1.0
2018-03-20 13:24:38 +02:00
*/
function update_files( $changes ) {
2019-10-21 23:39:19 +03:00
um_deprecated_function( 'update_files', '2.1.0', '' );
2018-03-20 13:24:38 +02:00
}
/**
* Update profile
*
* @param $changes
*/
function update_profile( $changes ) {
$args['ID'] = $this->id;
/**
* UM hook
*
* @type filter
* @title um_before_update_profile
* @description Change update profile changes data
* @input_vars
* [{"var":"$changes","type":"array","desc":"User Profile Changes"},
* {"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_before_update_profile', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_before_update_profile', 'my_before_update_profile', 10, 2 );
* function my_before_update_profile( $changes, $user_id ) {
* // your code here
* return $changes;
* }
* ?>
*/
2018-08-10 15:11:48 +03:00
$changes = apply_filters( 'um_before_update_profile', $changes, $args['ID'] );
2018-03-20 13:24:38 +02:00
foreach ( $changes as $key => $value ) {
if ( ! in_array( $key, $this->update_user_keys ) ) {
2019-05-08 16:05:27 +03:00
if ( $value === 0 ) {
2019-02-28 16:11:43 +02:00
update_user_meta( $this->id, $key, '0' );
} else {
update_user_meta( $this->id, $key, $value );
}
2018-03-20 13:24:38 +02:00
} else {
2018-06-18 15:40:30 +03:00
$args[ $key ] = esc_attr( $changes[ $key ] );
2018-03-20 13:24:38 +02:00
}
}
2018-05-25 18:22:38 +03:00
2018-03-20 13:24:38 +02:00
// update user
if ( count( $args ) > 1 ) {
2018-05-25 18:22:38 +03:00
//if isset roles argument validate role to properly for security reasons
if ( isset( $args['role'] ) ) {
global $wp_roles;
$um_roles = get_option( 'um_roles' );
2018-03-20 13:24:38 +02:00
2018-05-25 18:22:38 +03:00
if ( ! empty( $um_roles ) ) {
$role_keys = array_map( function( $item ) {
return 'um_' . $item;
}, get_option( 'um_roles' ) );
} else {
$role_keys = array();
}
2018-03-20 13:24:38 +02:00
2018-05-25 18:22:38 +03:00
$exclude_roles = array_diff( array_keys( $wp_roles->roles ), array_merge( $role_keys, array( 'subscriber' ) ) );
if ( in_array( $args['role'], $exclude_roles ) ) {
unset( $args['role'] );
}
2018-03-20 13:24:38 +02:00
}
wp_update_user( $args );
}
}
/**
* User exists by meta key and value
*
* @param $key
* @param $value
*
* @return bool|int
*/
function user_has_metadata( $key, $value ) {
$value = UM()->validation()->safe_name_in_url( $value );
2019-08-08 00:36:33 +03:00
$ids = get_users( array( 'fields' => 'ID', 'meta_key' => $key, 'meta_value' => $value, 'meta_compare' => '=' ) );
if ( ! isset( $ids ) || empty( $ids ) ) {
return false;
}
foreach ( $ids as $k => $id ) {
if ( $id == um_user('ID') ) {
unset( $ids[ $k ] );
2018-03-20 13:24:38 +02:00
} else {
$duplicates[] = $id;
}
2019-08-08 00:36:33 +03:00
2018-03-20 13:24:38 +02:00
}
2019-08-08 00:36:33 +03:00
if ( ! empty( $duplicates ) ) {
2018-03-20 13:24:38 +02:00
return count( $duplicates );
2019-08-08 00:36:33 +03:00
}
2018-03-20 13:24:38 +02:00
return false;
}
/**
* User exists by name
*
* @param $value
*
* @return bool
*/
function user_exists_by_name( $value ) {
// Permalink base
$permalink_base = UM()->options()->get( 'permalink_base' );
$raw_value = $value;
$value = UM()->validation()->safe_name_in_url( $value );
$value = um_clean_user_basename( $value );
// Search by Profile Slug
$args = array(
2019-08-08 00:36:33 +03:00
'fields' => array( 'ID' ),
2018-03-20 13:24:38 +02:00
'meta_query' => array(
'relation' => 'OR',
array(
2019-08-08 00:36:33 +03:00
'key' => 'um_user_profile_url_slug_' . $permalink_base,
'value' => strtolower( $raw_value ),
'compare' => '=',
),
),
2018-03-20 13:24:38 +02:00
);
$ids = new \WP_User_Query( $args );
2019-08-08 00:36:33 +03:00
if ( $ids->total_users > 0 ) {
2018-03-20 13:24:38 +02:00
$um_user_query = current( $ids->get_results() );
return $um_user_query->ID;
}
// Search by Display Name or ID
$args = array(
2019-08-08 00:36:33 +03:00
'fields' => array( 'ID' ),
'search' => $value,
'search_columns' => array( 'display_name', 'ID' ),
2018-03-20 13:24:38 +02:00
);
$ids = new \WP_User_Query( $args );
2019-08-08 00:36:33 +03:00
if ( $ids->total_users > 0 ) {
2018-03-20 13:24:38 +02:00
$um_user_query = current( $ids->get_results() );
return $um_user_query->ID;
}
// Search By User Login
2019-08-08 00:36:33 +03:00
$value = str_replace( ".", "_", $value );
$value = str_replace( " ", "", $value );
2018-03-20 13:24:38 +02:00
$args = array(
2019-08-08 00:36:33 +03:00
'fields' => array( 'ID' ),
'search' => $value,
'search_columns' => array(
2018-03-20 13:24:38 +02:00
'user_login',
)
);
$ids = new \WP_User_Query( $args );
2019-08-08 00:36:33 +03:00
if ( $ids->total_users > 0 ) {
2018-03-20 13:24:38 +02:00
$um_user_query = current( $ids->get_results() );
return $um_user_query->ID;
}
return false;
}
/**
* This method checks if a user exists or not in your site based on the user ID.
*
* @usage <?php UM()->user()->user_exists_by_id( $user_id ); ?>
*
* @param int $user_id A user ID must be passed to check if the user exists
*
* @return bool|int
*
* @example Basic Usage
<?php
$boolean = UM()->user()->user_exists_by_id( 15 );
if ( $boolean ) {
// That user exists
}
?>
*
*/
function user_exists_by_id( $user_id ) {
$aux = get_userdata( intval( $user_id ) );
2019-08-08 00:36:33 +03:00
if ( $aux == false ) {
2018-03-20 13:24:38 +02:00
return false;
} else {
return $user_id;
}
}
/**
* This method checks if a user exists or not in your site based on the user email as username
*
* @param string $slug A user slug must be passed to check if the user exists
*
* @usage <?php UM()->user()->user_exists_by_email_as_username( $slug ); ?>
*
* @return bool
*
* @example Basic Usage
<?php
$boolean = UM()->user()->user_exists_by_email_as_username( 'calumgmail-com' );
if ( $boolean ) {
// That user exists
}
?>
*/
function user_exists_by_email_as_username( $slug ) {
$user_id = false;
2019-08-08 00:36:33 +03:00
$ids = get_users( array( 'fields' => 'ID', 'meta_key' => 'um_email_as_username_' . $slug ) );
if ( ! empty( $ids[0] ) ) {
2018-03-20 13:24:38 +02:00
$user_id = $ids[0];
}
return $user_id;
}
/**
* Set gravatar hash id
*
* @param $user_id
* @return string
*/
function set_gravatar( $user_id ) {
um_fetch_user( $user_id );
$email_address = um_user( 'user_email' );
$hash_email_address = '';
if ( $email_address ) {
$hash_email_address = md5( $email_address );
$this->profile['synced_gravatar_hashed_id'] = $hash_email_address;
$this->update_usermeta_info( 'synced_gravatar_hashed_id' );
}
return $hash_email_address;
}
2019-05-06 17:22:57 +03:00
/**
* UM Placeholders for activation link in email
*
* @param $placeholders
*
* @return array
*/
function add_activation_placeholder( $placeholders ) {
$placeholders[] = '{account_activation_link}';
return $placeholders;
}
/**
* UM Replace Placeholders for activation link in email
*
* @param $replace_placeholders
*
* @return array
*/
function add_activation_replace_placeholder( $replace_placeholders ) {
$replace_placeholders[] = um_user( 'account_activation_link' );
return $replace_placeholders;
}
2018-03-20 13:24:38 +02:00
}
2017-07-26 14:57:52 +03:00
}