mirror of
https://github.com/10h30/ultimatemember.git
synced 2026-06-05 15:09:37 +09:00
nikitozzzzzzz
cbf06f5835
- fixed issues with permalinks (issue #375); - fixed replacing placeholders in [show_content_for_role] shortcode;
1402 lines
42 KiB
PHP
1402 lines
42 KiB
PHP
<?php
|
|
namespace um\core;
|
|
|
|
// Exit if accessed directly
|
|
if ( ! defined( 'ABSPATH' ) ) exit;
|
|
|
|
|
|
if ( ! class_exists( 'User' ) ) {
|
|
class User {
|
|
|
|
function __construct() {
|
|
|
|
$this->id = 0;
|
|
$this->usermeta = null;
|
|
$this->data = null;
|
|
$this->profile = null;
|
|
$this->cannot_edit = null;
|
|
$this->tabs = 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;
|
|
|
|
// a list of keys that should never be in wp_usermeta
|
|
$this->update_user_keys = array(
|
|
'user_email',
|
|
'user_pass',
|
|
'user_password',
|
|
'display_name',
|
|
'role',
|
|
);
|
|
|
|
$this->target_id = null;
|
|
|
|
// When the cache should be cleared
|
|
add_action('um_delete_user_hook', array(&$this, 'remove_cached_queue') );
|
|
add_action('um_after_user_status_is_changed_hook', array(&$this, 'remove_cached_queue') );
|
|
|
|
// When user cache should be cleared
|
|
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') );
|
|
//add_action('edit_user_profile_update', array(&$this, 'remove_cache') );
|
|
add_action('um_when_role_is_set', array(&$this, 'remove_cache') );
|
|
add_action('um_when_status_is_set', array(&$this, 'remove_cache') );
|
|
|
|
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 );
|
|
|
|
//on every update of user profile (hook from wp_update_user)
|
|
add_action( 'profile_update', array( &$this, 'profile_update' ), 10, 2 ); // user_id and old_user_data
|
|
|
|
//on user update profile page
|
|
//add_action( 'edit_user_profile_update', array( &$this, 'profile_update' ), 10, 1 );
|
|
|
|
add_action( 'user_register', array( &$this, 'user_register_via_admin' ), 10, 1 );
|
|
add_action( 'user_register', array( &$this, 'set_gravatar' ), 11, 1 );
|
|
|
|
|
|
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 );
|
|
|
|
add_action( 'init', array( &$this, 'check_membership' ), 10 );
|
|
}
|
|
|
|
|
|
function check_membership() {
|
|
if ( ! is_user_logged_in() )
|
|
return;
|
|
|
|
um_fetch_user( get_current_user_id() );
|
|
$status = um_user( 'account_status' );
|
|
|
|
if ( 'rejected' == $status ) {
|
|
wp_logout();
|
|
session_unset();
|
|
exit( wp_redirect( um_get_core_page( 'login' ) ) );
|
|
}
|
|
|
|
um_reset_user();
|
|
}
|
|
|
|
|
|
/**
|
|
* 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
|
|
if ( empty( $user_id ) )
|
|
return;
|
|
|
|
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
|
|
if ( empty( $user_id ) )
|
|
return;
|
|
|
|
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 );
|
|
}
|
|
|
|
|
|
/**
|
|
* 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' => '='
|
|
);
|
|
$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();
|
|
}
|
|
|
|
|
|
/**
|
|
* @param $user_id
|
|
*
|
|
* @return bool|mixed
|
|
*/
|
|
function get_profile_slug( $user_id ) {
|
|
// Permalink base
|
|
$permalink_base = UM()->options()->get( 'permalink_base' );
|
|
$profile_slug = get_user_meta( $user_id, "um_user_profile_url_slug_{$permalink_base}", true );
|
|
|
|
//get default username permalink if it's empty then return false
|
|
if ( empty( $profile_slug ) ) {
|
|
if ( $permalink_base != 'user_login' ) {
|
|
$profile_slug = get_user_meta( $user_id, "um_user_profile_url_slug_user_login", true );
|
|
}
|
|
|
|
if ( empty( $profile_slug ) ) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return $profile_slug;
|
|
}
|
|
|
|
|
|
/**
|
|
* @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;
|
|
}
|
|
|
|
return UM()->permalinks()->profile_permalink( $profile_slug );
|
|
}
|
|
|
|
|
|
/**
|
|
* @param $user_id
|
|
*/
|
|
function generate_profile_slug( $user_id, $force = false ) {
|
|
$userdata = get_userdata( $user_id );
|
|
|
|
if ( empty( $userdata ) ) {
|
|
return;
|
|
}
|
|
|
|
delete_option( "um_cache_userdata_{$user_id}" );
|
|
|
|
$current_profile_slug = $this->get_profile_slug( $user_id );
|
|
|
|
$user_in_url = '';
|
|
$permalink_base = UM()->options()->get( 'permalink_base' );
|
|
|
|
// User ID
|
|
if ( $permalink_base == 'user_id' ) {
|
|
$user_in_url = $user_id;
|
|
}
|
|
|
|
// Username
|
|
if ( $permalink_base == 'user_login' ) {
|
|
|
|
$user_in_url = $userdata->user_login;
|
|
|
|
if ( is_email( $user_in_url ) ) {
|
|
|
|
$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 );
|
|
|
|
}
|
|
}
|
|
|
|
// 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;
|
|
$full_name = trim( sprintf( '%s %s', $first_name, $last_name ) );
|
|
$full_name = preg_replace( '/\s+/', ' ', $full_name ); // Remove double spaces
|
|
$profile_slug = UM()->permalinks()->profile_slug( $full_name, $first_name, $last_name );
|
|
|
|
$append = 0;
|
|
$username = $full_name;
|
|
$_username = $full_name;
|
|
|
|
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;
|
|
}
|
|
$append++;
|
|
}
|
|
|
|
$user_in_url = UM()->permalinks()->profile_slug( $username, $first_name, $last_name );
|
|
if ( empty( $user_in_url ) ) {
|
|
$user_in_url = $userdata->user_login;
|
|
|
|
if ( is_email( $user_in_url ) ) {
|
|
|
|
$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 );
|
|
}
|
|
|
|
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 );
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Backend user creation
|
|
*
|
|
* @param $user_id
|
|
*/
|
|
function user_register_via_admin( $user_id ) {
|
|
|
|
if ( empty( $user_id ) )
|
|
return;
|
|
|
|
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' );
|
|
}
|
|
|
|
do_action( 'um_user_register', $user_id, $_POST );
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* On wp_update_user function complete
|
|
*
|
|
* @param int $user_id
|
|
* @param \WP_User $old_data
|
|
*/
|
|
function profile_update( $user_id, $old_data ) {
|
|
// Bail if no user ID was passed
|
|
if ( empty( $user_id ) ) {
|
|
return;
|
|
}
|
|
|
|
$old_roles = $old_data->roles;
|
|
$userdata = get_userdata( $user_id );
|
|
$new_roles = $userdata->roles;
|
|
|
|
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'] );
|
|
}
|
|
}
|
|
|
|
do_action( 'um_after_member_role_upgrade', $new_roles, $old_roles );
|
|
|
|
//Update permalink
|
|
$this->generate_profile_slug( $user_id, true );
|
|
|
|
$this->remove_cache( $user_id );
|
|
}
|
|
|
|
|
|
/**
|
|
* Additional section for WP Profile page with UM data fields
|
|
*
|
|
* @param \WP_User $userdata User data
|
|
* @return void
|
|
*/
|
|
function profile_form_additional_section( $userdata ) {
|
|
|
|
$section_content = apply_filters( 'um_user_profile_additional_fields', '', $userdata );
|
|
|
|
if ( ! empty( $section_content ) && ! ( is_multisite() && is_network_admin() ) ) {
|
|
|
|
if ( $userdata !== 'add-new-user' && $userdata !== 'add-existing-user' ) { ?>
|
|
<h3><?php esc_html_e( 'Ultimate Member', 'ultimate-member' ); ?></h3>
|
|
<?php }
|
|
|
|
echo $section_content;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* 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 ) {
|
|
//$role_meta['name'] = 'UM ' . $role_meta['name'];
|
|
$roles['um_' . $role_key] = $role_meta;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( empty( $roles ) )
|
|
return $content;
|
|
|
|
global $pagenow;
|
|
if ( 'profile.php' == $pagenow )
|
|
return $content;
|
|
|
|
$style = '';
|
|
$user_role = false;
|
|
if ( $userdata !== 'add-new-user' && $userdata !== 'add-existing-user' ) {
|
|
// Bail if current user cannot edit users
|
|
if ( ! current_user_can( 'edit_user', $userdata->ID ) )
|
|
return $content;
|
|
|
|
$user_role = UM()->roles()->get_um_user_role( $userdata->ID );
|
|
if ( $user_role && ! empty( $userdata->roles ) && count( $userdata->roles ) == 1 )
|
|
$style = 'style="display:none;"';
|
|
|
|
}
|
|
|
|
$class = ( $userdata == 'add-existing-user' ) ? 'um_role_existing_selector_wrapper' : 'um_role_selector_wrapper';
|
|
|
|
ob_start(); ?>
|
|
|
|
<div id="<?php echo $class ?>" <?php echo $style ?>>
|
|
<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 ) { ?>
|
|
<option <?php selected( $user_role, $role_id ); ?> value="<?php echo esc_attr( $role_id ); ?>"><?php echo $details['name']; ?></option>
|
|
<?php } ?>
|
|
</select>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<?php $content .= ob_get_clean();
|
|
|
|
return $content;
|
|
}
|
|
|
|
|
|
/***
|
|
*** @Remove cached queue from Users backend
|
|
***/
|
|
function remove_cached_queue() {
|
|
delete_option( 'um_cached_users_queue' );
|
|
}
|
|
|
|
/***
|
|
*** @Converts object to array
|
|
***/
|
|
function toArray($obj)
|
|
{
|
|
if (is_object($obj)) $obj = (array)$obj;
|
|
if (is_array($obj)) {
|
|
$new = array();
|
|
foreach ($obj as $key => $val) {
|
|
$new[$key] = $this->toArray($val);
|
|
}
|
|
} else {
|
|
$new = $obj;
|
|
}
|
|
|
|
return $new;
|
|
}
|
|
|
|
function get_cached_data( $user_id ) {
|
|
|
|
$disallow_cache = UM()->options()->get( 'um_profile_object_cache_stop' );
|
|
if( $disallow_cache ){
|
|
return '';
|
|
}
|
|
|
|
if ( is_numeric( $user_id ) && $user_id > 0 ) {
|
|
$find_user = get_option("um_cache_userdata_{$user_id}");
|
|
if ( $find_user ) {
|
|
$find_user = apply_filters('um_user_permissions_filter', $find_user, $user_id);
|
|
return $find_user;
|
|
}
|
|
}
|
|
return '';
|
|
}
|
|
|
|
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 );
|
|
}
|
|
|
|
function remove_cache( $user_id ) {
|
|
delete_option( "um_cache_userdata_{$user_id}" );
|
|
}
|
|
|
|
|
|
/**
|
|
* @function set()
|
|
*
|
|
* @description This method lets you set a user. For example, to retrieve a profile or anything related to that user.
|
|
*
|
|
* @usage <?php $ultimatemember->user->set( $user_id, $clean = false ); ?>
|
|
*
|
|
* @param $user_id (numeric) (optional) Which user to retrieve. A numeric user ID
|
|
* @param $clean (boolean) (optional) 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
|
|
*
|
|
* @returns This API method does not return anything. It sets user profile and permissions and allow you to retrieve any details for that user.
|
|
*
|
|
* @example The following example makes you set a user and retrieve their display name after that using the user API.
|
|
|
|
<?php
|
|
|
|
$ultimatemember->user->set( 12 );
|
|
$display_name = $ultimatemember->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
|
|
foreach( $this->usermeta as $k=>$v ) {
|
|
if ( $k == 'display_name') continue;
|
|
$this->profile[$k] = $v[0];
|
|
}
|
|
|
|
// 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 );
|
|
$role_meta = apply_filters( 'um_user_permissions_filter', $role_meta, $this->id );
|
|
|
|
/*$role_meta = array_map( function( $key, $item ) {
|
|
if ( strpos( $key, '_um_' ) === 0 )
|
|
$key = str_replace( '_um_', '', $key );
|
|
|
|
return array( $key => $item );
|
|
}, array_keys( $role_meta ), $role_meta );*/
|
|
|
|
$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
|
|
***/
|
|
function reset( $clean = false ){
|
|
$this->set(0, $clean);
|
|
}
|
|
|
|
/***
|
|
*** @Clean user profile
|
|
***/
|
|
function clean(){
|
|
foreach($this->profile as $key => $value){
|
|
foreach($this->banned_keys as $ban){
|
|
if (strstr($key, $ban) || is_numeric($key) )
|
|
unset($this->profile[$key]);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @function auto_login()
|
|
*
|
|
* @description This method lets you auto sign-in a user to your site.
|
|
*
|
|
* @usage <?php $ultimatemember->user->auto_login( $user_id, $rememberme = false ); ?>
|
|
*
|
|
* @param $user_id (numeric) (required) Which user ID to sign in automatically
|
|
* @param $rememberme (boolean) (optional) Should be true or false. If you want the user sign in session to use cookies, use true
|
|
*
|
|
* @returns Sign in the specified user automatically.
|
|
*
|
|
* @example The following example lets you sign in a user automatically by their ID.
|
|
|
|
<?php $ultimatemember->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 $ultimatemember->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 );
|
|
|
|
$user = get_user_by('ID', $user_id );
|
|
|
|
do_action( 'wp_login', $user->user_login, $user );
|
|
|
|
}
|
|
|
|
/***
|
|
*** @Set user's registration details
|
|
***/
|
|
function set_registration_details( $submitted ) {
|
|
|
|
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'] );
|
|
}
|
|
|
|
$submitted = apply_filters('um_before_save_filter_submitted', $submitted );
|
|
|
|
do_action('um_before_save_registration_details', $this->id, $submitted );
|
|
|
|
update_user_meta( $this->id, 'submitted', $submitted );
|
|
|
|
$this->update_profile( $submitted );
|
|
|
|
do_action('um_after_save_registration_details', $this->id, $submitted );
|
|
|
|
}
|
|
|
|
/***
|
|
*** @A plain version of password
|
|
***/
|
|
function set_plain_password( $plain ) {
|
|
update_user_meta( $this->id, '_um_cool_but_hard_to_guess_plain_pw', $plain );
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
***/
|
|
function set_status( $status ){
|
|
|
|
do_action( 'um_when_status_is_set', um_user('ID') );
|
|
|
|
$this->profile['account_status'] = $status;
|
|
|
|
$this->update_usermeta_info('account_status');
|
|
|
|
do_action( 'um_after_user_status_is_changed_hook' );
|
|
|
|
do_action( 'um_after_user_status_is_changed', $status);
|
|
|
|
}
|
|
|
|
/***
|
|
*** @Set user's hash for password reset
|
|
***/
|
|
function password_reset_hash(){
|
|
$this->profile['reset_pass_hash'] = UM()->validation()->generate();
|
|
$this->update_usermeta_info('reset_pass_hash');
|
|
|
|
}
|
|
|
|
/***
|
|
*** @Set user's hash
|
|
***/
|
|
function assign_secretkey(){
|
|
do_action('um_before_user_hash_is_changed');
|
|
|
|
$this->profile['account_secret_hash'] = UM()->validation()->generate();
|
|
$this->update_usermeta_info('account_secret_hash');
|
|
|
|
do_action('um_after_user_hash_is_changed');
|
|
|
|
}
|
|
|
|
/***
|
|
*** @password reset email
|
|
***/
|
|
function password_reset(){
|
|
$this->password_reset_hash();
|
|
UM()->mail()->send( um_user('user_email'), 'resetpw_email' );
|
|
}
|
|
|
|
|
|
/***
|
|
*** @password changed email
|
|
***/
|
|
function password_changed(){
|
|
UM()->mail()->send( um_user('user_email'), 'changedpw_email' );
|
|
}
|
|
|
|
/**
|
|
* @function approve()
|
|
*
|
|
* @description This method approves a user membership and sends them an optional welcome/approval e-mail.
|
|
*
|
|
* @usage <?php $ultimatemember->user->approve(); ?>
|
|
*
|
|
* @returns Approves a user membership.
|
|
*
|
|
* @example Approve a pending user and allow him to sign-in to your site.
|
|
|
|
<?php
|
|
|
|
um_fetch_user( 352 );
|
|
$ultimatemember->user->approve();
|
|
|
|
?>
|
|
|
|
*
|
|
*
|
|
*/
|
|
function approve(){
|
|
$user_id = um_user('ID');
|
|
delete_option( "um_cache_userdata_{$user_id}" );
|
|
|
|
if ( um_user('account_status') == 'awaiting_admin_review' ) {
|
|
$this->password_reset_hash();
|
|
UM()->mail()->send( um_user('user_email'), 'approved_email' );
|
|
|
|
} else {
|
|
$this->password_reset_hash();
|
|
UM()->mail()->send( um_user('user_email'), 'welcome_email');
|
|
}
|
|
|
|
$this->set_status('approved');
|
|
$this->delete_meta('account_secret_hash');
|
|
$this->delete_meta('_um_cool_but_hard_to_guess_plain_pw');
|
|
|
|
do_action('um_after_user_is_approved', um_user('ID') );
|
|
|
|
}
|
|
|
|
/***
|
|
*** @pending email
|
|
***/
|
|
function email_pending() {
|
|
$this->assign_secretkey();
|
|
$this->set_status('awaiting_email_confirmation');
|
|
UM()->mail()->send( um_user('user_email'), 'checkmail_email' );
|
|
}
|
|
|
|
/**
|
|
* @function pending()
|
|
*
|
|
* @description This method puts a user under manual review by administrator and sends them an optional e-mail.
|
|
*
|
|
* @usage <?php $ultimatemember->user->pending(); ?>
|
|
*
|
|
* @returns Puts a user under review and sends them an email optionally.
|
|
*
|
|
* @example An example of putting a user pending manual review
|
|
|
|
<?php
|
|
|
|
um_fetch_user( 54 );
|
|
$ultimatemember->user->pending();
|
|
|
|
?>
|
|
|
|
*
|
|
*
|
|
*/
|
|
function pending() {
|
|
$this->set_status( 'awaiting_admin_review' );
|
|
UM()->mail()->send( um_user( 'user_email' ), 'pending_email' );
|
|
}
|
|
|
|
/**
|
|
* @function reject()
|
|
*
|
|
* @description This method rejects a user membership and sends them an optional e-mail.
|
|
*
|
|
* @usage <?php $ultimatemember->user->reject(); ?>
|
|
*
|
|
* @returns Rejects a user membership.
|
|
*
|
|
* @example Reject a user membership example
|
|
|
|
<?php
|
|
|
|
um_fetch_user( 114 );
|
|
$ultimatemember->user->reject();
|
|
|
|
?>
|
|
|
|
*
|
|
*
|
|
*/
|
|
function reject(){
|
|
$this->set_status('rejected');
|
|
UM()->mail()->send( um_user('user_email'), 'rejected_email' );
|
|
}
|
|
|
|
/**
|
|
* @function deactivate()
|
|
*
|
|
* @description This method deactivates a user membership and sends them an optional e-mail.
|
|
*
|
|
* @usage <?php $ultimatemember->user->deactivate(); ?>
|
|
*
|
|
* @returns Deactivates a user membership.
|
|
*
|
|
* @example Deactivate a user membership with the following example
|
|
|
|
<?php
|
|
|
|
um_fetch_user( 32 );
|
|
$ultimatemember->user->deactivate();
|
|
|
|
?>
|
|
|
|
*
|
|
*
|
|
*/
|
|
function deactivate(){
|
|
$this->set_status('inactive');
|
|
|
|
do_action('um_after_user_is_inactive', um_user('ID') );
|
|
|
|
UM()->mail()->send( um_user('user_email'), 'inactive_email' );
|
|
}
|
|
|
|
|
|
/***
|
|
*** @delete user
|
|
***/
|
|
function delete( $send_mail = true ) {
|
|
do_action( 'um_delete_user_hook' );
|
|
do_action( 'um_delete_user', um_user('ID') );
|
|
|
|
// send email notifications
|
|
if ( $send_mail ) {
|
|
UM()->mail()->send( um_user('user_email'), 'deletion_email' );
|
|
UM()->mail()->send( um_admin_email(), 'notification_deletion', array('admin' => true ) );
|
|
}
|
|
|
|
// remove uploads
|
|
UM()->files()->remove_dir( um_user_uploads_dir() );
|
|
|
|
// remove user
|
|
if ( is_multisite() ) {
|
|
|
|
if ( !function_exists('wpmu_delete_user') ) {
|
|
require_once( ABSPATH . 'wp-admin/includes/ms.php' );
|
|
}
|
|
|
|
wpmu_delete_user( $this->id );
|
|
|
|
} else {
|
|
|
|
if ( !function_exists('wp_delete_user') ) {
|
|
require_once( ABSPATH . 'wp-admin/includes/user.php' );
|
|
}
|
|
|
|
wp_delete_user( $this->id );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* @function get_role()
|
|
*
|
|
* @description This method gets a user role in slug format. e.g. member
|
|
*
|
|
* @usage <?php $ultimatemember->user->get_role(); ?>
|
|
*
|
|
* @returns The user role's slug.
|
|
*
|
|
* @example Do something if the user's role is paid-member
|
|
|
|
<?php
|
|
|
|
um_fetch_user( 12 );
|
|
|
|
if ( $ultimatemember->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
|
|
***/
|
|
function update_usermeta_info( $key ) {
|
|
// delete the key first just in case
|
|
delete_user_meta( $this->id, $key );
|
|
update_user_meta( $this->id, $key, $this->profile[$key] );
|
|
}
|
|
|
|
/**
|
|
* @function delete_meta()
|
|
*
|
|
* @description This method can be used to delete user's meta key.
|
|
*
|
|
* @usage <?php $ultimatemember->user->delete_meta( $key ); ?>
|
|
*
|
|
* @param $key (string) (required) The meta field key to remove from user
|
|
*
|
|
* @returns This method will not return anything. The specified meta key will be deleted from database for the specified user.
|
|
*
|
|
* @example Delete user's age field
|
|
|
|
<?php
|
|
|
|
um_fetch_user( 15 );
|
|
$ultimatemember->user->delete_meta( 'age' );
|
|
|
|
?>
|
|
|
|
*
|
|
*
|
|
*/
|
|
function delete_meta( $key ){
|
|
delete_user_meta( $this->id, $key );
|
|
}
|
|
|
|
|
|
/***
|
|
*** @Get admin actions for individual user
|
|
***/
|
|
function get_admin_actions() {
|
|
$items = array();
|
|
$actions = array();
|
|
$actions = apply_filters('um_admin_user_actions_hook', $actions );
|
|
if ( !isset( $actions ) || empty( $actions ) ) return false;
|
|
foreach($actions as $id => $arr ) {
|
|
$url = add_query_arg('um_action', $id );
|
|
$url = add_query_arg('uid', um_profile_id(), $url );
|
|
$items[] = '<a href="' . $url .'" class="real_url '.$id.'-item">' . $arr['label'] . '</a>';
|
|
}
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* @function is_private_profile()
|
|
*
|
|
* @description This method checks if give user profile is private.
|
|
*
|
|
* @usage <?php $ultimatemember->user->is_private_profile( $user_id ); ?>
|
|
*
|
|
* @param $user_id (numeric) (required) A user ID must be passed to check if the user profile is private
|
|
*
|
|
* @returns Returns true if user profile is private and false if user profile is public.
|
|
*
|
|
* @example This example display a specific user's name If his profile is public
|
|
|
|
<?php
|
|
|
|
um_fetch_user( 60 );
|
|
$is_private = $ultimatemember->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 );
|
|
if ( $privacy == __('Only me','ultimate-member') ) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @function is_approved()
|
|
*
|
|
* @description This method can be used to determine If a certain user is approved or not.
|
|
*
|
|
* @usage <?php $ultimatemember->user->is_approved( $user_id ); ?>
|
|
*
|
|
* @param $user_id (numeric) (required) The user ID to check approval status for
|
|
*
|
|
* @returns True if user is approved and false if user is not approved.
|
|
*
|
|
* @example Do something If a user's membership is approved
|
|
|
|
<?php
|
|
|
|
if ( $ultimatemember->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
|
|
***/
|
|
function is_private_case( $user_id, $case ) {
|
|
$privacy = get_user_meta( $user_id, 'profile_privacy', true );
|
|
|
|
if ( $privacy == $case ) {
|
|
$bool = apply_filters('um_is_private_filter_hook', false, $privacy, $user_id );
|
|
return $bool;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/***
|
|
*** @update files
|
|
***/
|
|
function update_files( $changes ) {
|
|
|
|
foreach( $changes as $key => $uri ) {
|
|
$src = um_is_temp_upload( $uri );
|
|
UM()->files()->new_user_upload( $this->id, $src, $key );
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/***
|
|
*** @update profile
|
|
***/
|
|
function update_profile( $changes ) {
|
|
|
|
$args['ID'] = $this->id;
|
|
$changes = apply_filters('um_before_update_profile', $changes, $this->id);
|
|
|
|
// save or update profile meta
|
|
foreach ( $changes as $key => $value ) {
|
|
if ( ! in_array( $key, $this->update_user_keys ) ) {
|
|
|
|
update_user_meta( $this->id, $key, $value );
|
|
|
|
} else {
|
|
|
|
$args[$key] = esc_attr( $changes[$key] );
|
|
|
|
}
|
|
|
|
}
|
|
// update user
|
|
if ( count( $args ) > 1 ) {
|
|
global $wp_roles;
|
|
$um_roles = get_option( 'um_roles' );
|
|
|
|
if ( ! empty( $um_roles ) ) {
|
|
$role_keys = array_map( function( $item ) {
|
|
return 'um_' . $item;
|
|
}, get_option( 'um_roles' ) );
|
|
} else {
|
|
$role_keys = array();
|
|
}
|
|
|
|
$exclude_roles = array_diff( array_keys( $wp_roles->roles ), array_merge( $role_keys, array( 'subscriber' ) ) );
|
|
|
|
if ( isset( $args['role'] ) && in_array( $args['role'], $exclude_roles ) ) {
|
|
unset( $args['role'] );
|
|
}
|
|
|
|
wp_update_user( $args );
|
|
}
|
|
|
|
}
|
|
|
|
/***
|
|
*** @user exists by meta key and value
|
|
***/
|
|
function user_has_metadata( $key, $value ) {
|
|
|
|
$value = UM()->validation()->safe_name_in_url( $value );
|
|
|
|
$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] );
|
|
} else {
|
|
$duplicates[] = $id;
|
|
}
|
|
}
|
|
if ( isset( $duplicates ) && !empty( $duplicates ) )
|
|
return count( $duplicates );
|
|
return false;
|
|
}
|
|
|
|
|
|
/***
|
|
*** @user exists by name
|
|
***/
|
|
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(
|
|
"fields" => array("ID"),
|
|
'meta_query' => array(
|
|
'relation' => 'OR',
|
|
array(
|
|
'key' => 'um_user_profile_url_slug_'.$permalink_base,
|
|
'value' => strtolower( $raw_value ),
|
|
'compare' => '='
|
|
|
|
)
|
|
|
|
)
|
|
);
|
|
|
|
|
|
$ids = new \WP_User_Query( $args );
|
|
|
|
if( $ids->total_users > 0 ){
|
|
$um_user_query = current( $ids->get_results() );
|
|
return $um_user_query->ID;
|
|
}
|
|
|
|
// Search by Display Name or ID
|
|
$args = array(
|
|
"fields" => array("ID"),
|
|
"search" => $value,
|
|
'search_columns' => array( 'display_name','ID' )
|
|
);
|
|
|
|
$ids = new \WP_User_Query( $args );
|
|
|
|
if( $ids->total_users > 0 ){
|
|
$um_user_query = current( $ids->get_results() );
|
|
return $um_user_query->ID;
|
|
}
|
|
|
|
|
|
// Search By User Login
|
|
$value = str_replace(".", "_", $value );
|
|
$value = str_replace(" ", "", $value );
|
|
|
|
$args = array(
|
|
"fields" => array("ID"),
|
|
"search" => $value,
|
|
'search_columns' => array(
|
|
'user_login',
|
|
)
|
|
);
|
|
|
|
$ids = new \WP_User_Query( $args );
|
|
|
|
if( $ids->total_users > 0 ){
|
|
$um_user_query = current( $ids->get_results() );
|
|
return $um_user_query->ID;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
/**
|
|
* @function user_exists_by_id()
|
|
*
|
|
* @description This method checks if a user exists or not in your site based on the user ID.
|
|
*
|
|
* @usage <?php $ultimatemember->user->user_exists_by_id( $user_id ); ?>
|
|
*
|
|
* @param $user_id (numeric) (required) A user ID must be passed to check if the user exists
|
|
*
|
|
* @returns Returns true if user exists and false if user does not exist.
|
|
*
|
|
* @example Basic Usage
|
|
|
|
<?php
|
|
|
|
$boolean = $ultimatemember->user->user_exists_by_id( 15 );
|
|
if ( $boolean ) {
|
|
// That user exists
|
|
}
|
|
|
|
?>
|
|
|
|
*
|
|
*
|
|
*/
|
|
function user_exists_by_id( $user_id ) {
|
|
$aux = get_userdata( intval( $user_id ) );
|
|
if($aux==false){
|
|
return false;
|
|
} else {
|
|
return $user_id;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @function user_exists_by_email_as_username()
|
|
*
|
|
* @description This method checks if a user exists or not in your site based on the user email as username
|
|
*
|
|
* @usage <?php $ultimatemember->user->user_exists_by_email_as_username( $slug ); ?>
|
|
*
|
|
* @param $slug (string) (required) A user slug must be passed to check if the user exists
|
|
*
|
|
* @returns Returns true if user exists and false if user does not exist.
|
|
*
|
|
* @example Basic Usage
|
|
|
|
<?php
|
|
|
|
$boolean = $ultimatemember->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;
|
|
|
|
$ids = get_users( array( 'fields' => 'ID', 'meta_key' => 'um_email_as_username_'.$slug ) );
|
|
if ( isset( $ids[0] ) && ! empty( $ids[0] ) ){
|
|
$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;
|
|
}
|
|
|
|
}
|
|
}
|