<?php
namespace um\core;
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( ! class_exists( 'um\core\User' ) ) {
/**
* Class User
* @package um\core
*/
class User {
/**
* Data that we will set before the update profile to compare it after update
*
* @var null
*/
public $previous_data = null;
/**
* @var int
*/
public $id = 0;
/**
* @var null
*/
public $usermeta = null;
/**
* @var null
*/
public $data = null;
/**
* @var null
*/
public $profile = null;
/**
* @var null
*/
public $cannot_edit = null;
/**
* @var null
*/
public $deleted_user_id = null;
/**
* @var array|string[]
*/
public $banned_keys = array();
/**
* @var bool
*/
public $preview = false;
/**
* @var bool
*/
public $send_mail_on_delete = true;
/**
* A list of keys that should never be in wp_usermeta.
* @var array|string[]
*/
public $update_user_keys = array();
/**
* @var null
*/
public $target_id = null;
public $updating_process = false;
/**
* @var array
*/
public $cached_user = array();
/**
* User constructor.
*/
public function __construct() {
global $wpdb;
$this->banned_keys = array(
'metabox',
'postbox',
'meta-box',
'dismissed_wp_pointers',
'session_tokens',
'screen_layout',
$wpdb->get_blog_prefix() . 'user-',
'dismissed',
'cap_key',
$wpdb->get_blog_prefix() . 'capabilities',
'managenav',
'nav_menu',
'user_activation_key',
'level_',
$wpdb->get_blog_prefix() . 'user_level',
);
// a list of keys that should never be in wp_usermeta
$this->update_user_keys = array(
'user_email',
'user_pass',
'user_password',
'display_name',
'user_url',
'role',
);
add_action( 'init', array( &$this, 'set' ), 1 );
// When the cache should be cleared
add_action( 'um_delete_user', array( &$this, 'remove_cache' ), 10, 1 );
// 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( '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 );
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 );
}
add_action( 'init', array( &$this, 'check_membership' ), 10 );
if ( is_multisite() ) {
add_action( 'wpmu_delete_user', array( &$this, 'delete_user_handler' ), 10, 1 );
} else {
add_action( 'delete_user', array( &$this, 'delete_user_handler' ), 10, 1 );
}
add_action( 'updated_user_meta', array( &$this, 'on_update_usermeta' ), 10, 4 );
add_action( 'added_user_meta', array( &$this, 'on_update_usermeta' ), 10, 4 );
add_action( 'deleted_user_meta', array( &$this, 'on_delete_usermeta' ), 10, 4 );
add_action( 'update_user_meta', array( &$this, 'flush_um_count_users_transient_update' ), 10, 4 );
add_action( 'added_user_meta', array( &$this, 'flush_um_count_users_transient_add' ), 10, 4 );
add_action( 'delete_user_meta', array( &$this, 'flush_um_count_users_transient_delete' ), 10, 4 );
add_action( 'update_user_metadata', array( &$this, 'avoid_banned_keys' ), 10, 3 );
}
/**
* It validates the meta_key for wp_usermeta table.
* Avoid to handle `meta_key` by the UM Forms if it contains $this->banned_keys inside.
*
* @since 2.6.5
*
* @param string $meta_key Usermeta key.
* @return bool
*/
public function is_metakey_banned( $meta_key, $context = '' ) {
$is_banned = false;
foreach ( $this->banned_keys as $ban ) {
if ( is_numeric( $meta_key ) || false !== stripos( $meta_key, $ban ) || false !== stripos( remove_accents( $meta_key ), $ban ) ) {
$is_banned = true;
break;
}
}
if ( ! $is_banned && 'submission' === $context && ! in_array( $meta_key, UM()->form()->usermeta_whitelist, true ) ) {
$is_banned = true;
}
return $is_banned;
}
/**
* Low-level checking to avoid updating banned user metakeys while UM Forms submission.
*
* @since 2.6.4
*
* @param null|bool $check Whether to allow updating metadata for the given type.
* @param int $object_id ID of the object metadata is for.
* @param string $meta_key Metadata key.
*
* @return null|bool
*/
public function avoid_banned_keys( $check, $object_id, $meta_key ) {
if ( false === $this->updating_process ) {
return $check;
}
if ( $this->is_metakey_banned( $meta_key, 'submission' ) ) {
$check = false;
}
return $check;
}
/**
* @param $meta_ids
* @param $object_id
* @param $meta_key
* @param $_meta_value
*/
public function flush_um_count_users_transient_update( $meta_ids, $object_id, $meta_key, $_meta_value ) {
if ( 'account_status' !== $meta_key ) {
return;
}
// related to the User role > Registration Options Metabox > Registration status 2nd and 3rd option
if ( in_array( $_meta_value, array( 'checkmail', 'pending' ), true ) ) {
return;
}
$pending_statuses = array(
'awaiting_email_confirmation',
'awaiting_admin_review',
);
$old = get_user_meta( $object_id, $meta_key, true );
if ( $old === $_meta_value ) {
return;
}
// related to the User role > Registration Options Metabox > Registration status 2nd and 3rd option
if ( ! in_array( $old, array( 'checkmail', 'pending' ), true ) ) {
// deduct old transient count
$count = get_transient( "um_count_users_{$old}" );
if ( false !== $count ) {
if ( ! is_numeric( $count ) ) {
delete_transient( "um_count_users_{$old}" );
} else {
if ( 0 < $count ) {
$count--;
} else {
$count = 0;
}
set_transient( "um_count_users_{$old}", $count );
}
}
if ( in_array( $old, $pending_statuses, true ) && ! in_array( $_meta_value, $pending_statuses, true ) ) {
// deduct old transient count
$count = get_transient( 'um_count_users_pending_dot' );
if ( false !== $count ) {
if ( ! is_numeric( $count ) ) {
delete_transient( 'um_count_users_pending_dot' );
} else {
if ( 0 < $count ) {
$count--;
} else {
$count = 0;
}
set_transient( 'um_count_users_pending_dot', $count );
}
}
}
}
// add new transient count
$count = get_transient( "um_count_users_{$_meta_value}" );
if ( false !== $count ) {
if ( is_numeric( $count ) ) {
$count++;
} else {
$count = 1;
}
} else {
$count = 1;
}
set_transient( "um_count_users_{$_meta_value}", $count );
if ( in_array( $_meta_value, $pending_statuses, true ) && ! in_array( $old, $pending_statuses, true ) ) {
// add new transient count
$count = get_transient( 'um_count_users_pending_dot' );
if ( false !== $count ) {
if ( is_numeric( $count ) ) {
$count++;
} else {
$count = 1;
}
} else {
$count = 1;
}
set_transient( 'um_count_users_pending_dot', $count );
}
}
/**
* @param $meta_ids
* @param $object_id
* @param $meta_key
* @param $_meta_value
*/
public function flush_um_count_users_transient_add( $meta_ids, $object_id, $meta_key, $_meta_value ) {
if ( 'account_status' !== $meta_key ) {
return;
}
// related to the User role > Registration Options Metabox > Registration status 2nd and 3rd option
if ( in_array( $_meta_value, array( 'checkmail', 'pending' ), true ) ) {
return;
}
$pending_statuses = array(
'awaiting_email_confirmation',
'awaiting_admin_review',
);
// add new transient count
$count = get_transient( "um_count_users_{$_meta_value}" );
if ( false !== $count ) {
if ( is_numeric( $count ) ) {
$count++;
} else {
$count = 1;
}
} else {
$count = 1;
}
set_transient( "um_count_users_{$_meta_value}", $count );
if ( in_array( $_meta_value, $pending_statuses, true ) ) {
// add new transient count
$pending_count = get_transient( 'um_count_users_pending_dot' );
if ( false !== $pending_count ) {
if ( is_numeric( $pending_count ) ) {
$pending_count++;
} else {
$pending_count = 1;
}
} else {
$pending_count = 1;
}
set_transient( 'um_count_users_pending_dot', $pending_count );
}
}
/**
* @param $meta_ids
* @param $object_id
* @param $meta_key
* @param $_meta_value
*/
public function flush_um_count_users_transient_delete( $meta_ids, $object_id, $meta_key, $_meta_value ) {
if ( 'account_status' !== $meta_key ) {
return;
}
$value = ( '' !== $_meta_value ) ? $_meta_value : get_user_meta( $object_id, $meta_key, true );
// related to the User role > Registration Options Metabox > Registration status 2nd and 3rd option
if ( in_array( $value, array( 'checkmail', 'pending' ), true ) ) {
return;
}
$pending_statuses = array(
'awaiting_email_confirmation',
'awaiting_admin_review',
);
// deduct old transient count
$count = get_transient( "um_count_users_{$value}" );
if ( false !== $count ) {
if ( ! is_numeric( $count ) ) {
delete_transient( "um_count_users_{$value}" );
} else {
if ( 0 < $count ) {
$count--;
} else {
$count = 0;
}
set_transient( "um_count_users_{$value}", $count );
}
}
if ( in_array( $value, $pending_statuses, true ) ) {
// deduct old transient count
$count = get_transient( 'um_count_users_pending_dot' );
if ( false !== $count ) {
if ( ! is_numeric( $count ) ) {
delete_transient( 'um_count_users_pending_dot' );
} else {
if ( 0 < $count ) {
$count--;
} else {
$count = 0;
}
set_transient( 'um_count_users_pending_dot', $count );
}
}
}
}
/**
* When you delete usermeta connected with member directory - reset it to default value
*
* @param int|array $meta_ids
* @param int $object_id
* @param string $meta_key
* @param mixed $_meta_value
*/
public function on_delete_usermeta( $meta_ids, $object_id, $meta_key, $_meta_value ) {
if ( $this->deleted_user_id ) {
return;
}
$metakeys = array( 'account_status', 'hide_in_members', 'synced_gravatar_hashed_id', 'synced_profile_photo', 'profile_photo', 'cover_photo', '_um_verified' );
if ( ! in_array( $meta_key, $metakeys, true ) ) {
return;
}
// Set default if empty or has a wrong format.
$md_data = get_user_meta( $object_id, 'um_member_directory_data', true );
if ( empty( $md_data ) || ! is_array( $md_data ) ) {
$md_data = array(
'account_status' => 'approved',
'hide_in_members' => UM()->member_directory()->get_hide_in_members_default(),
'profile_photo' => false,
'cover_photo' => false,
'verified' => false,
);
}
switch ( $meta_key ) {
case 'account_status':
$md_data['account_status'] = 'approved';
break;
case 'hide_in_members':
$md_data['hide_in_members'] = UM()->member_directory()->get_hide_in_members_default();
break;
case 'synced_gravatar_hashed_id':
if ( UM()->options()->get( 'use_gravatars' ) ) {
$profile_photo = get_user_meta( $object_id, 'profile_photo', true );
$synced_profile_photo = get_user_meta( $object_id, 'synced_profile_photo', true );
$md_data['profile_photo'] = ! empty( $profile_photo ) || ! empty( $synced_profile_photo );
}
break;
case 'synced_profile_photo':
$profile_photo = get_user_meta( $object_id, 'profile_photo', true );
$synced_gravatar_hashed_id = false;
if ( UM()->options()->get( 'use_gravatars' ) ) {
$synced_gravatar_hashed_id = get_user_meta( $object_id, 'synced_gravatar_hashed_id', true );
}
$md_data['profile_photo'] = ! empty( $profile_photo ) || ! empty( $synced_gravatar_hashed_id );
break;
case 'profile_photo':
$synced_profile_photo = get_user_meta( $object_id, 'synced_profile_photo', true );
$synced_gravatar_hashed_id = false;
if ( UM()->options()->get( 'use_gravatars' ) ) {
$synced_gravatar_hashed_id = get_user_meta( $object_id, 'synced_gravatar_hashed_id', true );
}
$md_data['profile_photo'] = ! empty( $synced_profile_photo ) || ! empty( $synced_gravatar_hashed_id );
break;
case 'cover_photo':
$md_data['cover_photo'] = false;
break;
case '_um_verified':
$md_data['verified'] = false;
break;
}
update_user_meta( $object_id, 'um_member_directory_data', $md_data );
}
/**
* When you add/update usermeta connected with member directories - set this data to member directory metakey
*
* @param int $meta_id
* @param int $object_id
* @param string $meta_key
* @param mixed $_meta_value
*/
public function on_update_usermeta( $meta_id, $object_id, $meta_key, $_meta_value ) {
$metakeys = array( 'account_status', 'hide_in_members', 'synced_gravatar_hashed_id', 'synced_profile_photo', 'profile_photo', 'cover_photo', '_um_verified' );
if ( ! in_array( $meta_key, $metakeys, true ) ) {
return;
}
// Set default if empty or has a wrong format.
$md_data = get_user_meta( $object_id, 'um_member_directory_data', true );
if ( empty( $md_data ) || ! is_array( $md_data ) ) {
$md_data = array(
'account_status' => 'approved',
'hide_in_members' => UM()->member_directory()->get_hide_in_members_default(),
'profile_photo' => false,
'cover_photo' => false,
'verified' => false,
);
}
switch ( $meta_key ) {
case 'account_status':
$md_data['account_status'] = $_meta_value;
break;
case 'hide_in_members':
$hide_in_members = UM()->member_directory()->get_hide_in_members_default();
if ( ! empty( $_meta_value ) ) {
if ( 'Yes' === $_meta_value || __( 'Yes', 'ultimate-member' ) === $_meta_value ||
array_intersect( array( 'Yes', __( 'Yes', 'ultimate-member' ) ), $_meta_value ) ) {
$hide_in_members = true;
} else {
$hide_in_members = false;
}
}
$md_data['hide_in_members'] = $hide_in_members;
break;
case 'synced_gravatar_hashed_id':
if ( UM()->options()->get( 'use_gravatars' ) ) {
if ( empty( $md_data['profile_photo'] ) ) {
$md_data['profile_photo'] = ! empty( $_meta_value );
}
}
break;
case 'synced_profile_photo':
case 'profile_photo':
if ( empty( $md_data['profile_photo'] ) ) {
$md_data['profile_photo'] = ! empty( $_meta_value );
}
break;
case 'cover_photo':
$md_data['cover_photo'] = ! empty( $_meta_value );
break;
case '_um_verified':
$md_data['verified'] = 'verified' === $_meta_value;
break;
}
update_user_meta( $object_id, 'um_member_directory_data', $md_data );
}
/**
* @param $user_id
*/
public function delete_user_handler( $user_id ) {
um_fetch_user( $user_id );
$this->deleted_user_id = $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' ) );
// remove user's comments
if ( UM()->options()->get( 'delete_comments' ) ) {
$user = get_user_by( 'id', um_user( 'ID' ) );
$comments = array_merge( get_comments( 'author_email=' . $user->user_email ), get_comments( 'user_id=' . um_user( 'ID' ) ) );
foreach ( $comments as $comment ) {
wp_delete_comment( $comment->comment_ID, true );
}
}
// send email notifications
if ( $this->send_mail_on_delete ) {
$user_email = um_user( 'user_email' );
$template = 'deletion_email';
UM()->maybe_action_scheduler()->enqueue_async_action( 'um_dispatch_email', array( $user_email, $template ) );
$emails = um_multi_admin_email();
if ( ! empty( $emails ) ) {
foreach ( $emails as $email ) {
UM()->maybe_action_scheduler()->enqueue_async_action( 'um_dispatch_email', array( $email, 'notification_deletion', array( 'admin' => true ) ) );
}
}
}
// remove uploads
UM()->files()->remove_dir( UM()->files()->upload_temp );
UM()->files()->remove_dir( UM()->uploader()->get_upload_base_dir() . um_user( 'ID' ) . DIRECTORY_SEPARATOR );
delete_transient( 'um_count_users_unassigned' );
delete_transient( 'um_count_users_pending_dot' );
}
/**
*
*/
public function check_membership() {
if ( ! is_user_logged_in() ) {
return;
}
if ( UM()->common()->users()->has_status( get_current_user_id(), 'rejected' ) ) {
wp_logout();
session_unset();
um_safe_redirect( um_get_core_page( 'login' ) );
exit;
}
}
/**
* 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'] ) && current_user_can( 'promote_users' ) ) {
if ( ! user_can( $user_id, sanitize_key( $_POST['um-role'] ) ) ) {
UM()->roles()->set_role( $user_id, sanitize_key( $_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'] ) && current_user_can( 'promote_users' ) ) {
if ( ! user_can( $user_id, sanitize_key( $_POST['um-role'] ) ) ) {
UM()->roles()->set_role( $user_id, sanitize_key( $_POST['um-role'] ) );
}
}
$this->remove_cache( $user_id );
}
/**
* @param int $user_id
* @param bool $raw
*
* @return bool|mixed
*/
public function get_profile_slug( $user_id, $raw = false ) {
// Permalink base
$permalink_base = UM()->options()->get( 'permalink_base' );
if ( 'custom_meta' === $permalink_base ) {
$custom_meta = UM()->options()->get( 'permalink_base_custom_meta' );
if ( empty( $custom_meta ) ) {
// Set default permalink base if custom meta is empty.
$permalink_base = 'user_login';
$meta_key = 'um_user_profile_url_slug_' . $permalink_base;
} else {
$meta_key = $custom_meta;
}
} else {
$meta_key = 'um_user_profile_url_slug_' . $permalink_base;
}
$profile_slug = get_user_meta( $user_id, $meta_key, true );
if ( $raw ) {
return $profile_slug;
}
//get default username permalink if it's empty then return false
if ( empty( $profile_slug ) ) {
if ( 'user_login' !== $permalink_base ) {
$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 );
}
public function generate_user_hash( $user_id ) {
$user_id = absint( $user_id );
$append = 0;
while ( 1 ) {
$user_in_url = '~' . substr( strrev( md5( uniqid( 'um_user_hash' . $append, true ) . $user_id ) ), 0, 18 );
$slug_exists_user_id = UM()->permalinks()->slug_exists_user_id( $user_in_url );
if ( empty( $slug_exists_user_id ) || $user_id === $slug_exists_user_id ) {
break;
}
$append++;
}
return $user_in_url;
}
/**
* Generate User Profile Slug and save to meta
*
* @param int $user_id
* @param bool $force
*/
public 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, true );
$user_in_url = '';
$permalink_base = UM()->options()->get( 'permalink_base' );
// User ID
if ( 'user_id' === $permalink_base ) {
$user_in_url = $user_id;
}
if ( 'hash' === $permalink_base ) {
if ( empty( $current_profile_slug ) ) {
$user_in_url = $this->generate_user_hash( $user_id );
} else {
$user_in_url = $current_profile_slug;
}
}
if ( 'custom_meta' === $permalink_base ) {
$custom_meta = UM()->options()->get( 'permalink_base_custom_meta' );
if ( empty( $custom_meta ) ) {
// Set default permalink base if custom meta is empty.
$permalink_base = 'user_login';
} else {
$user_in_url = rawurlencode( get_user_meta( $user_id, $custom_meta, true ) );
/**
* Filters the user profile slug when custom meta is set.
*
* @param {string} $slug User profile slug.
* @param {int} $user_id User ID.
* @param {string} $metakey Meta key.
*
* @return {string} User profile slug.
*
* @since 2.7.0
* @hook um_custom_meta_permalink_base_generate_user_slug
*
* @example <caption>Use base64encode value as user slug.</caption>
* function my_custom_meta_permalink_base_generate_user_slug( $slug, $user_id, $metakey ) {
* // your code here
* $slug = base64encode( $user_id );
* update_user_meta( $user_id, $metakey, $slug );
* $slug = rawurlencode( $slug );
* return $slug;
* }
* add_filter( 'um_custom_meta_permalink_base_generate_user_slug', 'my_custom_meta_permalink_base_generate_user_slug', 10, 3 );
*/
$user_in_url = apply_filters( 'um_custom_meta_permalink_base_generate_user_slug', $user_in_url, $user_id, $custom_meta );
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 = urlencode( $user_in_url );
}
update_user_meta( $user_id, "um_user_profile_url_slug_user_login", $user_in_url );
}
}
}
// Username
if ( 'user_login' === $permalink_base ) {
$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 = urlencode( $user_in_url );
}
}
// Fisrt and Last name
$full_name_permalinks = array( 'name', 'name_dash', 'name_plus' );
if ( in_array( $permalink_base, $full_name_permalinks, true ) ) {
$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 );
}
$user_in_url = apply_filters( 'um_change_user_profile_slug', $user_in_url, $user_id );
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'] ) && current_user_can( 'promote_users' ) ) {
$user = get_userdata( $user_id );
$user->add_role( sanitize_key( $_POST['um-role'] ) );
UM()->user()->profile['role'] = sanitize_key( $_POST['um-role'] );
UM()->user()->update_usermeta_info( 'role' );
}
/** This action is documented in ultimate-member/includes/common/um-actions-register.php */
do_action( 'um_user_register', $user_id, $_POST, null );
}
delete_transient( 'um_count_users_unassigned' );
}
/**
* 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 ( is_admin() ) {
if ( ! empty( $_POST['um-role'] ) && current_user_can( 'promote_users' ) ) {
$new_roles = array_merge( $new_roles, array( sanitize_key( $_POST['um-role'] ) ) );
if ( ! user_can( $user_id, sanitize_key( $_POST['um-role'] ) ) ) {
UM()->roles()->set_role( $user_id, sanitize_key( $_POST['um-role'] ) );
}
}
}
/**
* 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
* }
* ?>
*/
do_action( 'um_after_member_role_upgrade', $new_roles, $old_roles, $user_id );
//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 ) {
/**
* 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;
* }
* ?>
*/
$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 id="um_user_screen_block"><?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', array() );
if ( $role_keys ) {
foreach ( $role_keys as $role_key ) {
$role_meta = get_option( "um_role_{$role_key}_meta" );
if ( $role_meta ) {
$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 esc_attr( $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 esc_html( $details['name'] ); ?></option>
<?php } ?>
</select>
</td>
</tr>
</tbody>
</table>
</div>
<?php
$content .= ob_get_clean();
return $content;
}
/**
* Converts object to array
*
* @param $obj
*
* @return 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;
}
/**
* @param $user_id
*
* @return mixed|string
*/
public 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 ) {
/** This filter is documented in includes/core/class-roles-capabilities.php */
return apply_filters( 'um_user_permissions_filter', $find_user, $user_id );
}
}
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}" );
}
/**
* 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_%'" );
}
/**
* 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 );
} elseif ( 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';
}
$this->usermeta['account_status_name'][0] = UM()->common()->users()->get_status( $this->id, 'formatted' );
// add user meta
foreach ( $this->usermeta as $k => $v ) {
if ( 'display_name' === $k ) {
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 );
/** This filter is documented in includes/core/class-roles-capabilities.php */
$role_meta = apply_filters( 'um_user_permissions_filter', $role_meta, $this->id );
$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 before set.
*/
private function clean() {
foreach ( $this->profile as $key => $value ) {
if ( $this->is_metakey_banned( $key ) ) {
unset( $this->profile[ $key ] );
}
}
}
/**
* 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 ); ?>
*
*/
public 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
*
* @param array $submitted
* @param array $args
* @param array $form_data
*/
public function set_registration_details( $submitted, $args, $form_data ) {
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'] );
}
//remove all password field values from submitted details
$password_fields = array();
foreach ( $submitted as $k => $v ) {
if ( 'password' === UM()->fields()->get_field_type( $k ) ) {
$password_fields[] = $k;
$password_fields[] = 'confirm_' . $k;
}
}
foreach ( $password_fields as $pw_field ) {
unset( $submitted[ $pw_field ] );
}
/**
* Filters submitted data before save usermeta "submitted" on registration process.
*
* @param {array} $submitted Form submitted data prepared for submitted usermeta.
* @param {array} $form_submitted_data All submitted data from $_POST. Since 2.6.7.
* @param {array} $form_data Form data. Since 2.6.7.
*
* @return {array} Form submitted data prepared for submitted usermeta.
*
* @since 2.0
* @hook um_before_save_filter_submitted
*
* @example <caption>Change submitted data before save usermeta "submitted" on registration process.</caption>
* function my_before_save_filter_submitted( $submitted, $form_submitted_data, $form_data ) {
* // your code here
* return $submitted;
* }
* add_filter( 'um_before_save_filter_submitted', 'my_before_save_filter_submitted', 10, 3 );
*/
$submitted = apply_filters( 'um_before_save_filter_submitted', $submitted, $args, $form_data );
/**
* Fires before save registration details to the user.
*
* @since 1.3.x
* @hook um_before_save_registration_details
*
* @param {int} $user_id User ID.
* @param {array} $submitted_data $_POST Submission array.
* @param {array} $form_data Form data. Since 2.6.8.
*
* @example <caption>Make any custom action before save registration details to the user.</caption>
* function my_before_save_registration_details( $user_id, $submitted_data, $form_data ) {
* // your code here
* }
* add_action( 'um_before_save_registration_details', 'my_before_save_registration_details', 10, 3 );
*/
do_action( 'um_before_save_registration_details', $this->id, $submitted, $form_data );
update_user_meta( $this->id, 'submitted', $submitted );
$this->update_profile( $submitted );
/**
* Fires after save registration details to the user.
*
* @since 1.3.x
* @hook um_after_save_registration_details
*
* @param {int} $user_id User ID.
* @param {array} $submitted_data $_POST Submission array.
* @param {array} $form_data UM form data. Since 2.6.7
*
* @example <caption>Make any custom action after save registration details to the user.</caption>
* function my_after_save_registration_details( $user_id, $submitted_data, $form_data ) {
* // your code here
* }
* add_action( 'um_after_save_registration_details', 'my_after_save_registration_details', 10, 3 );
*/
do_action( 'um_after_save_registration_details', $this->id, $submitted, $form_data );
}
/**
* Set last login for new registered users
*/
public function set_last_login() {
update_user_meta( $this->id, '_um_last_login', current_time( 'mysql', true ) );
}
/**
* Set user's account status
*
* @deprecated 2.8.7
*
* @param string $status
*/
public function set_status( $status ) {
_deprecated_function( __METHOD__, '2.8.7', 'UM()->common()->users()->set_status()' );
UM()->common()->users()->set_status( $status, um_user( 'ID' ) );
}
/**
* Set user's hash
*
* @deprecated 2.8.7
*/
public function assign_secretkey() {
_deprecated_function( __METHOD__, '2.8.7', 'UM()->common()->users()->assign_secretkey()' );
UM()->common()->users()->assign_secretkey( um_user( 'ID' ) );
}
/**
* @param \WP_User $userdata
*
* @return string|\WP_Error
*/
function maybe_generate_password_reset_key( $userdata ) {
return get_password_reset_key( $userdata );
}
/**
* Password reset email
*/
function password_reset() {
$userdata = get_userdata( um_user( 'ID' ) );
$this->maybe_generate_password_reset_key( $userdata );
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 );
UM()->maybe_action_scheduler()->enqueue_async_action( 'um_dispatch_email', array( $userdata->user_email, 'resetpw_email' ) );
}
/**
* Password changed email
*
* @param null|int $user_id
*/
function password_changed( $user_id = null ) {
if ( ! empty( $user_id ) ) {
um_fetch_user( $user_id );
}
UM()->maybe_action_scheduler()->enqueue_async_action( 'um_dispatch_email', array( um_user( 'user_email' ), 'changedpw_email' ) );
if ( ! empty( $user_id ) ) {
um_reset_user();
}
}
/**
* This method approves a user membership and sends them an optional welcome/approval email.
* @param bool $repeat @deprecated
* @deprecated 2.8.7
*/
public function approve( $repeat = true ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found -- deprecated function
_deprecated_function( __METHOD__, '2.8.7', 'UM()->common()->users()->approve()' );
UM()->common()->users()->approve( um_user( 'ID' ), $repeat );
}
/**
* Pending email
* @deprecated 2.8.7
*/
public function email_pending() {
_deprecated_function( __METHOD__, '2.8.7', 'UM()->common()->users()->send_activation()' );
UM()->common()->users()->send_activation( um_user( 'ID' ) );
}
/**
* This method puts a user under manual review by administrator and sends them an optional email.
* @deprecated 2.8.7
* @return void
*/
public function pending() {
_deprecated_function( __METHOD__, '2.8.7', 'UM()->common()->users()->set_as_pending()' );
UM()->common()->users()->set_as_pending( um_user( 'ID' ) );
}
/**
* This method rejects a user membership and sends them an optional email.
* @deprecated 2.8.7
* @return void
*/
public function reject() {
_deprecated_function( __METHOD__, '2.8.7', 'UM()->common()->users()->reject()' );
UM()->common()->users()->reject( um_user( 'ID' ) );
}
/**
* This method deactivates a user membership and sends them an optional email.
* @deprecated 2.8.7
* @return void
*/
public function deactivate() {
_deprecated_function( __METHOD__, '2.8.7', 'UM()->common()->users()->deactivate()' );
UM()->common()->users()->deactivate( um_user( 'ID' ) );
}
/**
* Delete user
*
* @param bool $send_mail
*/
public function delete( $send_mail = true ) {
$this->send_mail_on_delete = $send_mail;
// Don't send email notification to not approved user
if ( ! UM()->common()->users()->has_status( $this->id, 'approved' ) ) {
$this->send_mail_on_delete = false;
}
// 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 );
}
}
/**
* 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 ( ! empty( $this->profile['wp_roles'] ) && $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 );
update_user_meta( $this->id, $key, $this->profile[ $key ] );
}
/**
* 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' );
?>
*
*/
function delete_meta( $key ) {
delete_user_meta( $this->id, $key );
}
/**
* Get admin actions for individual user
*
* @return array|bool
*/
function get_admin_actions() {
$items = array();
$actions = UM()->frontend()->users()->get_actions_list( um_profile_id() );
if ( empty( $actions ) ) {
return $items;
}
foreach ( $actions as $id => $arr ) {
$url = add_query_arg(
array(
'um_action' => $id,
'uid' => um_profile_id(),
'nonce' => wp_create_nonce( $id . um_profile_id() ),
)
);
$items[] = '<a href="' . esc_url( $url ) . '" class="real_url ' . esc_attr( $id ) . '-item">' . esc_html( $arr['label'] ) . '</a>';
}
return $items;
}
/**
* This method checks if the profile indexing is disabled
*
* @param int $user_id
*
* @since 2.1.16
* @usage <?php UM()->user()->is_profile_noindex( $user_id ); ?>
*
* @return boolean Is the profile indexing disabled?
*/
function is_profile_noindex( $user_id ) {
$profile_noindex = false;
if ( ! get_option( 'blog_public' ) ) {
// Option "Search engine visibility" in [wp-admin > Settings > Reading]
$profile_noindex = true;
} elseif ( $this->is_private_profile( $user_id ) ) {
// Setting "Profile Privacy" in [Account > Privacy]
$profile_noindex = true;
} elseif ( get_user_meta( $user_id, 'profile_noindex', true ) === '1' ) {
// Setting "Avoid indexing my profile by search engines in [Account > Privacy]
$profile_noindex = true;
}
if ( ! $profile_noindex ) {
$role = UM()->roles()->get_priority_user_role( $user_id );
$permissions = UM()->roles()->role_data( $role );
if ( isset( $permissions['profile_noindex'] ) && '' !== $permissions['profile_noindex'] ) {
// Setting "Avoid indexing profile by search engines" in [wp-admin > Ultimate Member > User Roles > Edit Role]
$profile_noindex = (bool) $permissions['profile_noindex'];
} else {
// Setting "Avoid indexing profile by search engines" in [wp-admin > Ultimate Member > Settings > General > Users]
$profile_noindex = (bool) UM()->options()->get( 'profile_noindex' );
}
}
return apply_filters( 'um_user_is_profile_noindex', $profile_noindex, $user_id, $this );
}
/**
* 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 );
if ( $privacy == __( 'Only me', 'ultimate-member' ) || $privacy == 'Only me' ) {
return true;
}
return $this->is_private_case( $user_id, $privacy );
}
/**
* 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
*
* @return bool
*/
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
*
* @deprecated 2.1.0
*/
function update_files( $changes ) {
um_deprecated_function( 'update_files', '2.1.0', '' );
}
/**
* Update profile
*
* @param array $changes
* @param string $context
*/
public function update_profile( $changes, $context = '' ) {
if ( 'account' !== $context ) {
$this->updating_process = true;
}
$args['ID'] = $this->id;
/**
* Filters the update profile changes data.
*
* @since 1.3.x
* @hook um_before_update_profile
*
* @param {array} $changes User Profile Changes.
* @param {int} $user_id User ID.
*
* @return {array} User Profile Changes.
*
* @example <caption>Remove some_metakey from changes where user ID equals 12.</caption>
* function my_custom_before_update_profile( $changes, $user_id ) {
* if ( 12 === $user_id ) {
* unset( $changes['{some_metakey}'];
* }
* return $changes;
* }
* add_filter( 'um_before_update_profile', 'my_custom_before_update_profile', 10, 2 );
*/
$changes = apply_filters( 'um_before_update_profile', $changes, $args['ID'] );
foreach ( $changes as $key => $value ) {
if ( $this->is_metakey_banned( $key, ( 'account' !== $context ) ? 'submission' : '' ) ) {
continue;
}
if ( ! in_array( $key, $this->update_user_keys, true ) ) {
if ( $value === 0 ) {
update_user_meta( $this->id, $key, '0' );
} else {
update_user_meta( $this->id, $key, $value );
}
} else {
$args[ $key ] = $value;
}
}
$this->updating_process = false;
// update user
if ( count( $args ) > 1 ) {
// If isset roles argument validate role to properly for security reasons
if ( isset( $args['role'] ) ) {
global $wp_roles;
$exclude_roles = array_diff( array_keys( $wp_roles->roles ), UM()->roles()->get_editable_user_roles() );
if ( in_array( $args['role'], $exclude_roles, true ) ) {
unset( $args['role'] );
}
}
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 );
$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 ( ! empty( $duplicates ) ) {
return count( $duplicates );
}
return false;
}
/**
* User exists by name
*
* @param $value
*
* @return bool
*/
public 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( array( '.', ' ' ), array( '_', '' ), $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;
}
/**
* This method checks if a user exists or not in your site based on the user ID.
*
* @deprecated 2.8.7
*
* @param int $user_id A user ID must be passed to check if the user exists
*
* @return bool|int
*/
public function user_exists_by_id( $user_id ) {
_deprecated_function( __METHOD__, '2.8.7', 'UM()->common()->users()::user_exists' );
return UM()->common()->users()::user_exists( $user_id ) ? $user_id : false;
}
/**
* @param string $hash
*
* @return bool|int
*/
public function user_exists_by_hash( $hash ) {
// Permalink base
$permalink_base = UM()->options()->get( 'permalink_base' );
$raw_value = $hash;
// 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;
}
return false;
}
/**
* @param string $slug
*
* @return bool|int
*/
public function user_exists_by_custom_meta( $slug ) {
$permalink_base = UM()->options()->get( 'permalink_base' );
$custom_meta = UM()->options()->get( 'permalink_base_custom_meta' );
if ( empty( $custom_meta ) ) {
// Set default permalink base if custom meta is empty.
$permalink_base = 'user_login';
$meta_key = 'um_user_profile_url_slug_' . $permalink_base;
} else {
$meta_key = $custom_meta;
}
$raw_value = $slug;
// Search by Profile Slug
$args = array(
'fields' => array( 'ID' ),
'meta_query' => array(
'relation' => 'OR',
array(
'key' => $meta_key,
'value' => strtolower( $raw_value ),
'compare' => '=',
),
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;
}
return false;
}
/**
* 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;
$ids = get_users(
array(
'fields' => 'ID',
'meta_key' => 'um_email_as_username_' . $slug,
)
);
if ( ! 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;
}
/**
* UM Placeholders for activation link in email
*
* @param $placeholders
*
* @return array
*/
public function add_activation_placeholder( $placeholders ) {
$placeholders[] = '{account_activation_link}';
return $placeholders;
}
/**
* UM Replace Placeholders for activation link in email
*
* @param $replace_placeholders
*
* @return array
*/
public function add_activation_replace_placeholder( $replace_placeholders ) {
$replace_placeholders[] = um_user( 'account_activation_link' );
return $replace_placeholders;
}
}
}