DOING_AJAX
DOING_AJAX
um |
Array2XML | |
Browser | Modified to remove var Chris Christoff on 12/26/2012 Changes: Changes vars to publics |
UltimateMember_Unit_Tests_Bootstrap | Ultimate Member Tests Bootstrap |
UM | Main UM Class |
UM_Emails_List_Table | Class UM_Emails_List_Table |
UM_Functions | Class UM_Functions |
UM_Menu_Item_Custom_Fields_Editor | Class UM_Menu_Item_Custom_Fields_Editor |
UM_Roles_List_Table | Class UM_Roles_List_Table |
UM() : \UM
Function for calling UM methods and variables
um_closest_num( $array, $number) : mixed
Find closest number in an array
$array | ||
$number |
package |
Default |
---|
um_comment_link_to_profile( $return, $author, $comment_ID) : string
Control comment author display
$return | ||
$author | ||
$comment_ID |
package |
Default |
---|
um_conditional_nav_menu( $items, $menu, $args) : mixed
Conditional menu items
$items | ||
$menu | ||
$args |
package |
Default |
---|
um_control_admin_bar( $content) : boolean
Hide admin bar appropriately
$content |
package |
Default |
---|
um_convert_tags( $content, array $args = array(), boolean $with_kses = true) : mixed|string
Convert template tags
$content | ||
array | $args | |
boolean | $with_kses |
package |
Default |
---|
package |
Default |
---|
um_custom_wp_err_messages( $message) : string
Filter to customize errors
$message |
package |
Default |
---|
um_deprecated_function(string $function, string $version, string $replacement = null)
Wrapper for deprecated functions so we can apply some extra logic.
string | $function | |
string | $version | |
string | $replacement |
package |
Default |
---|---|
since | 2.0 |
um_display_login_errors( $args)
Display the login errors from other plugins
$args |
package |
Default |
---|
um_dynamic_login_page_redirect(string $redirect_to = '') : boolean|false|mixed|string|void
Get where user should be headed after logging
string | $redirect_to |
package |
Default |
---|
um_dynamic_user_profile_pagetitle( $title, string $sep = '') : mixed|string
Fix for plugin "The SEO Framework", dynamic profile page title
$title | ||
string | $sep |
package |
Default |
---|
um_dynamic_user_profile_title( $title, string $id = '') : string
Try and modify the page title in page
$title | ||
string | $id |
package |
Default |
---|
um_edit_label_all_fields( $label, $data) : string
Field is required?
$label | ||
$data |
package |
Default |
---|
um_edit_my_profile_cancel_uri(string $url = '') : mixed|string|void
Remove edit profile args from url
string | $url |
package |
Default |
---|
um_edit_profile_url() : mixed|string|void
Returns the edit profile link
package |
Default |
---|
um_edit_url_field_value( $value, $key) : string
Cleaning on XSS injection for url editing field
$value | string |
|
$key | string |
$value
package |
Default |
---|
um_editing_user_id_input( $args)
If editing another user
$args |
package |
Default |
---|
um_fetch_user( $user_id)
Sets a specific user and prepares profile data and user permissions and makes them accessible.
$user_id | (numeric) (required) A user ID is required. This is the user's ID that you wish to set/retrieve |
** File not found : The **
** File not found : In **
package |
Default |
---|---|
function |
um_fetch_user() |
description |
This function sets a user and allow you to retrieve any information for the retrieved user |
usage |
<?php um_fetch_user( $user_id ); ?> |
um_field_conditions_are_met( $data) : boolean
If conditions are met return true;
$data |
package |
Default |
---|
um_field_non_utf8_value(string $value) : string
Filter non-UTF8 strings
string | $value |
package |
Default |
---|
um_filter_search(string $search) : string
Filters the search query.
string | $search |
package |
Default |
---|
um_filtered_social_link( $key, $match) : mixed|string|void
Show filtered social link
$key | ||
$match |
package |
Default |
---|
um_filtered_value( $key, boolean $data = false) : mixed|string|void
Get filtered meta value after applying hooks
$key | ||
boolean | $data |
package |
Default |
---|
um_force_utf8_fields(mixed $value, array $data, string $type = '') : mixed
Force fields to use UTF-8 encoding
mixed | $value | |
array | $data | |
string | $type |
package |
Default |
---|
um_force_utf8_string(mixed $value) : mixed
Force strings to UTF-8 encoded
mixed | $value |
package |
Default |
---|
um_get_avatar(string $avatar = '', string $id_or_email = '', string $size = '96', string $avatar_class = '', string $default = '', string $alt = '') : string
Get user UM avatars
string | $avatar | |
string | $id_or_email | |
string | $size | |
string | $avatar_class | |
string | $default | |
string | $alt |
returns avatar in image html elements
package |
Default |
---|---|
hooks |
filter |
um_get_avatar_uri( $image, $attrs) : boolean|string
get avatar uri
$image | ||
$attrs |
package |
Default |
---|
um_get_avatar_url( $get_avatar) : mixed
get avatar URL instead of image
$get_avatar |
package |
Default |
---|
um_get_core_page( $slug, boolean $updated = false) : boolean|false|mixed|string|void
Get core page url
$slug | ||
boolean | $updated |
package |
Default |
---|
um_get_cover_uri( $image, $attrs) : boolean|string
get cover uri
$image | ||
$attrs |
package |
Default |
---|
package |
Default |
---|
um_get_custom_field_array( $array, $fields) : mixed
Validate conditional logic
$array | ||
$fields |
package |
Default |
---|
package |
Default |
---|
um_get_default_cover_uri() : mixed|string|void
default cover
package |
Default |
---|
um_get_display_name( $user_id) : string
Get a user's display name
$user_id |
package |
Default |
---|
package |
Default |
---|
um_get_form_fields( $array) : mixed|string
Get form fields
$array |
package |
Default |
---|
um_get_host() : mixed
Get user host
Returns the webhost this site is using if possible
string $host if detected, false otherwise
package |
Default |
---|---|
since | 1.3.68 |
package |
Default |
---|
um_get_metadefault( $id) : string
Get meta option default
$id |
package |
Default |
---|
um_get_option( $option_id) : mixed|string|void
Get option value
Please use UM()->options()->get() instead
$option_id |
package |
Default |
---|
um_get_redirect_url(string $key) : string
Set redirect key
string | $key |
$redirect_key
package |
Default |
---|
um_get_requested_user() : boolean|null
Gets the requested user
package |
Default |
---|
package |
Default |
---|
um_get_search_form() : string
Returns the ultimate member search form
package |
Default |
---|
package |
Default |
---|
um_get_snippet( $str, integer $wordCount = 10) : string
Get limit of words from sentence
$str | ||
integer | $wordCount |
package |
Default |
---|
um_get_url_for_language( $post_id, $language) : boolean|false|string
Get a translated core page URL
$post_id | ||
$language |
package |
Default |
---|
um_get_user_avatar_url() : boolean|string
get user avatar url
package |
Default |
---|
um_hide_metabox_restrict_content_shop( $hide) : boolean
$hide |
package |
Default |
---|
um_is_core_page(string $page) : boolean
Check if we are on a UM Core Page or not
Default um core pages slugs 'user', 'login', 'register', 'members', 'logout', 'account', 'password-reset'
string | $page | UM core page slug |
package |
Default |
---|
um_is_core_post( $post, $core_page) : boolean
$post | ||
$core_page |
package |
Default |
---|
package |
Default |
---|
um_is_meta_value_exists(string $key, mixed $value, mixed $return_user_id = false) : integer
Check if meta_value exists
string | $key | |
mixed | $value | |
mixed | $return_user_id |
package |
Default |
---|
package |
Default |
---|
um_is_on_edit_profile() : boolean
boolean for profile edit page
package |
Default |
---|
um_is_selected_filter_value(mixed $value) : mixed
Filter profile data value
mixed | $value |
package |
Default |
---|
um_is_session_started() : boolean
Checks if session has been started
package |
Default |
---|
um_is_temp_image( $url) : boolean|string
Check that temp image is valid
$url |
package |
Default |
---|
um_is_temp_upload( $url) : boolean|string
Check that temp upload is valid
$url |
package |
Default |
---|
package |
Default |
---|
um_let_to_num(string $v) : integer|string
Let To Num
Does Size Conversions
string | $v |
package |
Default |
---|---|
since | 1.3.68 |
author |
Chris Christoff |
um_logout_user_links( $args)
Adds main links to a logout widget
$args |
package |
Default |
---|
um_mail_content_type( $content_type) : string
$content_type |
package |
Default |
---|
um_members( $argument) : mixed
Get members to show in directory
$argument |
package |
Default |
---|
um_members_directory_display( $args)
Member Directory Display
$args |
package |
Default |
---|
um_members_directory_head( $args)
Member Directory Header
$args |
package |
Default |
---|
um_members_directory_pagination( $args)
Member Directory Pagination
$args |
package |
Default |
---|
um_members_directory_search( $args)
Member Directory Search
$args |
package |
Default |
---|
um_modify_sortby_randomly( $query) : mixed
Sorting random
$query |
package |
Default |
---|
um_multisite_urls_support( $dir) : string
Support multisite
$dir |
package |
Default |
---|
um_option_match_callback_view_field( $value, $data) : string
Pair dropdown/multi-select options from a callback function
$value | string |
|
$data | array |
package |
Default |
---|
um_post_registration_approved_hook( $user_id, $args)
Account automatically approved
$user_id | ||
$args |
package |
Default |
---|
um_post_registration_checkmail_hook( $user_id, $args)
Account needs email validation
$user_id | ||
$args |
package |
Default |
---|
um_post_registration_pending_hook( $user_id, $args)
Account needs admin review
$user_id | ||
$args |
package |
Default |
---|
um_pre_directory_shortcode( $args)
Pre-display Member Directory
$args |
package |
Default |
---|
um_pre_profile_shortcode( $args)
Adds profile permissions to view/edit
$args |
package |
Default |
---|
um_prepare_user_query_args( $query_args, $args) : mixed
Adds main parameters
$query_args | ||
$args |
package |
Default |
---|
um_prepare_user_results_array( $result) : mixed
Hook in the member results array
$result |
package |
Default |
---|
um_pretty_number_formatting( $count) : string
Formats numbers nicely
$count |
package |
Default |
---|
package |
Default |
---|
um_profile_content_main( $args)
Um_profile_content_{main_tab}
$args |
package |
Default |
---|
package |
Default |
---|
um_profile_field__select_translate( $value, $data) : string
Apply textdomain in select/multi-select options
$value | string |
|
$data | array |
package |
Default |
---|
um_profile_field_filter_hook__( $value, $data, string $type = '') : string
Global sanitize
$value | ||
$data | ||
string | $type |
package |
Default |
---|
um_profile_field_filter_hook__date( $value, $data) : string
Date field
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__file( $value, $data) : string|void
File field
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__googlemap( $value, $data) : string
Outputs a google map
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__image( $value, $data) : string
Image field
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__last_login( $value, $data) : string
Last login date
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__soundcloud_track( $value, $data) : string|void
Outputs a soundcloud track
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__textarea( $value, $data) : mixed|string|void
URLs in textarea
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__time( $value, $data) : mixed|string
Time field
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__user_registered( $value, $data) : false|integer|string
User's registration date
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__vimeo_video( $value, $data) : integer|string
Outputs a vimeo video
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_hook__youtube_video( $value, $data) : boolean|string
Outputs a youtube video
$value | ||
$data |
package |
Default |
---|
um_profile_field_filter_xss_validation( $value, $data, string $type = '') : string
Cleaning on XSS injection
$value | string |
|
$data | array |
|
string | $type |
$value
package |
Default |
---|
package |
Default |
---|
um_profile_header_cover_area( $args)
Profile header cover
$args |
package |
Default |
---|
package |
Default |
---|
um_profile_menu(array $args)
Display the available profile tabs
array | $args |
package |
Default |
---|
um_queried_search_value( $filter, boolean $echo = true) : mixed|string
Check value of queried search in text input
$filter | ||
boolean | $echo |
package |
Default |
---|
package |
Default |
---|
um_query_args_gender__filter(array $field_query) : array
Filter gender query argument
array | $field_query |
package |
Default |
---|
um_registration_save_files( $user_id, $args)
Saving files to register a new user, if there are fields with files
$user_id | ||
$args |
package |
Default |
---|
um_registration_set_profile_full_name( $user_id, $args)
Update user Full Name
$user_id | ||
$args |
package |
Default |
---|---|
profile |
name update |
um_remove_option( $option_id)
Update option value
Please use UM()->options()->remove() instead
$option_id |
package |
Default |
---|
um_remove_special_users_from_list( $query_args, $args) : mixed
Remove users we do not need to show in directory
$query_args | ||
$args |
package |
Default |
---|
um_remove_unused_uploads( $user_id, $post_array)
Clean user temp uploads
$user_id | ||
$post_array |
package |
Default |
---|
um_requesting_password_change() : boolean
Check if a legitimate password change request is in action
package |
Default |
---|
um_requesting_password_reset() : boolean
Check if a legitimate password reset request is in action
package |
Default |
---|
um_reset_password_errors_hook( $args)
Error handler: reset password
$args |
package |
Default |
---|
package |
Default |
---|
um_reset_password_page_hidden_fields( $args)
Hidden fields
$args |
package |
Default |
---|
um_reset_password_process_hook( $args)
Process a new request
$args |
package |
Default |
---|
um_reset_user()
Clears the user data. If a user is logged in, the user data will be reset to that user's data
** File not found : You **
package |
Default |
---|---|
function |
um_reset_user() |
description |
This function resets the current user. You can use it to reset user data after retrieving the details of a specific user. |
usage |
<?php um_reset_user(); ?> |
um_reset_user_clean()
Clears the user data. You need to fetch a user manually after using this function.
** File not found : You **
package |
Default |
---|---|
function |
um_reset_user_clean() |
description |
This function is similar to um_reset_user() with a difference that it will not use the logged-in user data after resetting. It is a hard-reset function for all user data. |
usage |
<?php um_reset_user_clean(); ?> |
um_restore_default_roles( $user_id, $args, $to_update)
Leave roles for User, which are not in the list of update profile (are default WP or 3rd plugins roles)
$user_id | ||
$args | ||
$to_update |
package |
Default |
---|
um_search_select_fields( $atts) : array
Retrieves search filter options from a callback
$atts | array |
package |
Default |
---|
um_search_usernames_emails( $query_args, $args) : mixed
WP API user search
$query_args | ||
$args |
package |
Default |
---|
um_secure_media_uri(string $url) : string
Set SSL to media URI
string | $url |
package |
Default |
---|
um_select_dropdown_dynamic_callback_options( $options, $data) : array
Returns dropdown/multi-select options from a callback function
$options | array |
|
$data | array |
package |
Default |
---|
um_select_dropdown_dynamic_options_to_utf8(array $options, array $data) : array
Filter select dropdown to use UTF-8 encoding
array | $options | |
array | $data |
package |
Default |
---|
um_select_if_in_query_params( $filter, $val)
Check whether item in dropdown is selected in query-url
$filter | ||
$val |
package |
Default |
---|
um_send_password_change_email( $args) : boolean
Overrides password changed notification
$args |
package |
Default |
---|
um_send_registration_notification( $user_id, $args)
Send notification about registration
$user_id | ||
$args |
package |
Default |
---|
um_set_redirect_url(string $url) : string
Set redirect key
string | $url |
$redirect_key
package |
Default |
---|
um_set_requested_user( $user_id)
Sets the requested user
$user_id |
package |
Default |
---|
um_social_links_icons( $args)
Show social links as icons below profile name
$args |
package |
Default |
---|
um_sortby_last_login( $query_args, $sortby) : mixed
Sorting by last login date
$query_args | ||
$sortby |
package |
Default |
---|
um_store_lastlogin_timestamp( $user_id)
Store last login timestamp
$user_id |
package |
Default |
---|
package |
Default |
---|
um_styling_defaults( $mode) : array
Get styling defaults
$mode |
package |
Default |
---|
um_submit_account_details( $args)
Submit account page changes
$args |
package |
Default |
---|
um_submit_account_errors_hook( $args)
Validate for errors in account form
$args |
package |
Default |
---|
um_submit_form_data_role_fields( $post_form, $mode) : \$post_form
add role_select and role_radio to the $post_form It is necessary for that if on these fields the conditional logic
$post_form | array |
|
$mode |
package |
Default |
---|
package |
Default |
---|
um_submit_form_errors_hook_( $args)
Error processing hook : standard
$args |
package |
Default |
---|
um_submit_form_errors_hook__blockedemails( $args)
Error handling: blocked emails
$args |
package |
Default |
---|
um_submit_form_errors_hook__blockedips( $args)
Error handling: blocked IPs
$args |
package |
Default |
---|
um_submit_form_errors_hook__blockedwords( $args)
Error handling: blocked words during sign up
$args |
package |
Default |
---|
um_submit_form_errors_hook_login( $args)
Error procesing hook for login
$args |
package |
Default |
---|
um_submit_form_errors_hook_logincheck( $args)
Login checks thru the frontend login
$args |
package |
Default |
---|
package |
Default |
---|
package |
Default |
---|
um_submit_form_register( $args) : boolean|integer|\WP_Error
Registration form submit handler
$args |
package |
Default |
---|
um_submitting_account_page() : boolean
boolean for account page editing
package |
Default |
---|
um_time_diff( $time1, $time2) : mixed|void
Get core page url
$time1 | ||
$time2 |
package |
Default |
---|
um_trim_string( $s, integer $length = 20) : string
Trim string by char length
$s | ||
integer | $length |
package |
Default |
---|
um_update_option( $option_id, $value)
Update option value
Please use UM()->options()->update() instead
$option_id | ||
$value |
package |
Default |
---|
um_update_profile_full_name( $user_id, $changes)
Profile name update
$user_id | ||
$changes |
package |
Default |
---|
package |
Default |
---|
um_user_edit_profile(array $args)
Update user's profile
array | $args |
package |
Default |
---|
um_user_ip() : string
The user's IP address.
** File not found : The **
package |
Default |
---|---|
function |
um_user_ip() |
description |
This function returns the IP address of user. |
usage |
<?php $user_ip = um_user_ip(); ?> |
um_user_last_login( $user_id) : mixed|string|void
Get user's last login (time diff)
$user_id |
package |
Default |
---|
um_user_last_login_date( $user_id) : string
Get user's last login time
$user_id |
package |
Default |
---|
um_user_last_login_timestamp( $user_id) : mixed|string
Get user's last login timestamp
$user_id |
package |
Default |
---|
package |
Default |
---|
um_user_profile_url(integer|boolean $user_id = false) : boolean|string
Display a link to profile page
integer|boolean | $user_id |
package |
Default |
---|
um_user_submitted_registration(boolean $style = false) : null|string
Get submitted user information
boolean | $style |
package |
Default |
---|
package |
Default |
---|
package |
Default |
---|
um_whitelisted_wpadmin_access( $allowed) : integer
Filter to allow whitelisted IP to access the wp-admin login
$allowed |
package |
Default |
---|
um_wp_form_errors_hook_ip_test( $user, $username, $password) : mixed
Check for blocked ip
$user | ||
$username | ||
$password |
package |
Default |
---|