\

Namespaces

um

Classes

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

Constants

DOING_AJAX

DOING_AJAX

ultimatemember_plugin_name

ultimatemember_plugin_name

ultimatemember_version

ultimatemember_version

UM_DOING_API

UM_DOING_API

um_path

um_path

um_path

um_path

um_plugin

um_plugin

um_plugin

um_plugin

UM_TEXTDOMAIN

UM_TEXTDOMAIN

um_url

um_url

um_url

um_url

Functions

is_ultimatemember()

is_ultimatemember() : boolean

Check if we are on UM page

Returns

boolean

offer_version_sort()

offer_version_sort(  $first,   $second) 

Parameters

$first
$second

ultimatemember_check_username_exists()

ultimatemember_check_username_exists() : boolean

Run check if username exists

Returns

boolean

ultimatemember_plugin_links()

ultimatemember_plugin_links(array  $links) : array

Add any custom links to plugin page

Parameters

array $links

Returns

array

UM()

UM() : \UM

Function for calling UM methods and variables

Returns

\UM

um_access_profile()

um_access_profile(integer  $user_id) 

Profile Access

Parameters

integer $user_id

um_account_disable_name_fields()

um_account_disable_name_fields(array  $fields) : array

Disables first and last name fields in account page

Parameters

array $fields

Returns

array

um_account_page_hidden_fields()

um_account_page_hidden_fields(  $args) 

Hidden inputs for account form

Parameters

$args

um_account_secure_fields()

um_account_secure_fields(array  $fields, string  $tab_key) : array

Account secure fields

Parameters

array $fields
string $tab_key

Returns

array

um_account_secure_registered_fields()

um_account_secure_registered_fields() 

Update account fields to secure the account submission

um_action_request_process()

um_action_request_process() 

Processes the requests of UM actions

um_add_custom_message_to_menu()

um_add_custom_message_to_menu(  $items,   $args) : mixed

Add dynamic profile headers

Parameters

$items
$args

Returns

mixed

um_add_edit_icon()

um_add_edit_icon(  $args) 

Display the edit profile icon

Parameters

$args

um_add_form_honeypot_css()

um_add_form_honeypot_css() 

Makes the honeypot invisible

um_add_form_honeypot_js()

um_add_form_honeypot_js() 

Empty the honeypot value

um_add_form_identifier()

um_add_form_identifier(  $args) 

Adds a form identifier to form

Parameters

$args

um_add_login_fields()

um_add_login_fields(  $args) 

Show Fields

Parameters

$args

um_add_profile_fields()

um_add_profile_fields(  $args) 

Show Fields

Parameters

$args

um_add_register_fields()

um_add_register_fields(  $args) 

Show Fields

Parameters

$args

um_add_search_to_query()

um_add_search_to_query(  $query_args,   $args) : mixed|void

Adds search parameters

Parameters

$query_args
$args

Returns

mixed|void

um_add_security_checks()

um_add_security_checks(  $args) 

Adds a spam timestamp

Parameters

$args

um_add_submit_button_to_login()

um_add_submit_button_to_login(  $args) 

Show the submit button

Parameters

$args

um_add_submit_button_to_profile()

um_add_submit_button_to_profile(  $args) 

Show the submit button (highest priority)

Parameters

$args

um_add_submit_button_to_register()

um_add_submit_button_to_register(  $args) 

Show the submit button

Parameters

$args

um_add_update_notice()

um_add_update_notice(  $args) 

Add a notice to form

Parameters

$args

um_add_user_role()

um_add_user_role(  $args) 

Register user with predefined role in options

Parameters

$args

um_admin_add_conditional_support()

um_admin_add_conditional_support(  $form_id,   $field_args,   $in_edit,   $edit_array) 

Footer of modal

Parameters

$form_id
$field_args
$in_edit
$edit_array

um_admin_add_message_handlers()

um_admin_add_message_handlers() 

Put status handler in modal

um_admin_do_action__duplicate_form()

um_admin_do_action__duplicate_form(  $action) 

Duplicate form

Parameters

$action

um_admin_do_action__hide_notice()

um_admin_do_action__hide_notice(  $action) 

Action to hide notices in admin

Parameters

$action

um_admin_do_action__purge_temp()

um_admin_do_action__purge_temp(  $action) 

Purge temp uploads dir

Parameters

$action

um_admin_do_action__um_language_downloader()

um_admin_do_action__um_language_downloader(  $action) 

Download a language remotely

Parameters

$action

um_admin_do_action__user_action()

um_admin_do_action__user_action(  $action) 

Various user actions

Parameters

$action

um_admin_do_action__user_cache()

um_admin_do_action__user_cache(  $action) 

Clear all users cache

Parameters

$action

um_admin_email()

um_admin_email() : mixed|string|void

Short for admin e-mail

Returns

mixed|string|void

um_admin_field_update_error_handling()

um_admin_field_update_error_handling(  $errors,   $array) : mixed

Apply a filter to handle errors for field updating in backend

Parameters

$errors
$array

Returns

mixed

um_admin_pre_save_field_to_form()

um_admin_pre_save_field_to_form(  $array) : mixed

Modify field args just before it is saved into form

Parameters

$array

Returns

mixed

um_admin_pre_save_fields_hook()

um_admin_pre_save_fields_hook(  $array) : mixed

Some fields may require extra fields before saving

Parameters

$array

Returns

mixed

um_admin_user_action_hook()

um_admin_user_action_hook(string  $action) 

Does an action to user asap

Parameters

string $action

um_admin_user_actions_hook()

um_admin_user_actions_hook(  $actions) : null

Main admin user actions

Parameters

$actions

Returns

null

um_admin_wpml_post_options()

um_admin_wpml_post_options(array  $fields, array  $data) : array

Add option for WPML

Parameters

array $fields
array $data

Returns

array

um_after_changing_user_password()

um_after_changing_user_password(  $user_id) 

This is executed after changing password

Parameters

$user_id

um_after_insert_user()

um_after_insert_user(  $user_id,   $args) 

After insert a new user run at frontend and backend

Parameters

$user_id
$args

um_after_login_submit()

um_after_login_submit(  $args) 

Display a forgot password link

Parameters

$args

um_after_user_account_updated_permalink()

um_after_user_account_updated_permalink(  $user_id,   $changed) 

Update Profile URL

Parameters

$user_id
$changed

um_auth_username_password_before()

um_auth_username_password_before(  $user,   $username,   $password) 

Remove authenticate filter

Parameters

$user
$username
$password

um_avatar_defaults()

um_avatar_defaults(  $avatar_defaults) : mixed

Do not apply to backend default avatars

Parameters

$avatar_defaults

Returns

mixed

um_before_account_delete()

um_before_account_delete() 

Before delete account tab content

um_before_account_notifications()

um_before_account_notifications() 

Before notifications account tab content

um_before_update_profile()

um_before_update_profile(array  $changes, integer  $user_id) : array

Filter before update profile to force utf8 strings

Parameters

array $changes
integer $user_id

Returns

array

um_before_user_upload()

um_before_user_upload(integer  $user_id, array  $arr_files) 

Clean up file for new uploaded files

Parameters

integer $user_id
array $arr_files

um_block_wpadmin_by_user_role()

um_block_wpadmin_by_user_role() 

Checks if user can access the backend

um_browser_url_redirect_to()

um_browser_url_redirect_to(  $args) 

Add a force redirect to from $_get

Parameters

$args

um_builtin_validation_types_continue_loop()

um_builtin_validation_types_continue_loop(  $break,   $key,   $form_id,   $field_array) : boolean

Filter validation types on loop

Parameters

$break
$key
$form_id
$field_array

Returns

boolean

um_can_edit_field()

um_can_edit_field(  $data) : boolean

Can edit field

Parameters

$data

Returns

boolean

um_can_edit_my_profile()

um_can_edit_my_profile() : boolean

checks if user can edit his profile

Returns

boolean

um_can_view_field()

um_can_view_field(  $data) : boolean

Can view field

Parameters

$data

Returns

boolean

um_can_view_profile()

um_can_view_profile(  $user_id) : boolean

Checks if user can view profile

Parameters

$user_id

Returns

boolean

um_change_password_errors_hook()

um_change_password_errors_hook(  $args) 

Error handler: changing password

Parameters

$args

um_change_password_form()

um_change_password_form() 

Change password form

um_change_password_page_hidden_fields()

um_change_password_page_hidden_fields(  $args) 

Hidden fields

Parameters

$args

um_change_password_process_hook()

um_change_password_process_hook(  $args) 

Process a change request

Parameters

$args

um_change_profile_cover_photo_label()

um_change_profile_cover_photo_label(  $args) : mixed

Add cover photo label of file size limit

Parameters

$args

Returns

mixed

um_change_profile_photo_label()

um_change_profile_photo_label(  $args) : mixed

Add profile photo label of file size limit

Parameters

$args

Returns

mixed

um_check_user_status()

um_check_user_status(  $user_id,   $args) 

Check user status and redirect it after registration

Parameters

$user_id
$args

um_clean_user_basename()

um_clean_user_basename(  $value) : mixed|void

User clean basename

Parameters

$value

Returns

mixed|void

um_clean_user_basename_filter()

um_clean_user_basename_filter(string  $value,   $raw) : string

Filter user basename

Parameters

string $value
$raw

Returns

string

um_clickable_links()

um_clickable_links(  $s) : mixed

Convert urls to clickable links

Parameters

$s

Returns

mixed

um_closest_num()

um_closest_num(  $array,   $number) : mixed

Find closest number in an array

Parameters

$array
$number

Returns

mixed

um_comment_link_to_profile()

um_comment_link_to_profile(  $return,   $author,   $comment_ID) : string

Control comment author display

Parameters

$return
$author
$comment_ID

Returns

string

um_conditional_nav_menu()

um_conditional_nav_menu(  $items,   $menu,   $args) : mixed

Conditional menu items

Parameters

$items
$menu
$args

Returns

mixed

um_control_admin_bar()

um_control_admin_bar(  $content) : boolean

Hide admin bar appropriately

Parameters

$content

Returns

boolean

um_convert_tags()

um_convert_tags(  $content, array  $args = array(), boolean  $with_kses = true) : mixed|string

Convert template tags

Parameters

$content
array $args
boolean $with_kses

Returns

mixed|string

um_core_is_local()

um_core_is_local() : boolean

Check if running local

Returns

boolean

um_custom_wp_err_messages()

um_custom_wp_err_messages(  $message) : string

Filter to customize errors

Parameters

$message

Returns

string

um_deprecated_function()

um_deprecated_function(string  $function, string  $version, string  $replacement = null) 

Wrapper for deprecated functions so we can apply some extra logic.

Parameters

string $function
string $version
string $replacement

um_display_login_errors()

um_display_login_errors(  $args) 

Display the login errors from other plugins

Parameters

$args

um_dynamic_login_page_redirect()

um_dynamic_login_page_redirect(string  $redirect_to = '') : boolean|false|mixed|string|void

Get where user should be headed after logging

Parameters

string $redirect_to

Returns

boolean|false|mixed|string|void

um_dynamic_user_profile_pagetitle()

um_dynamic_user_profile_pagetitle(  $title, string  $sep = '') : mixed|string

Fix for plugin "The SEO Framework", dynamic profile page title

Parameters

$title
string $sep

Returns

mixed|string

um_dynamic_user_profile_title()

um_dynamic_user_profile_title(  $title, string  $id = '') : string

Try and modify the page title in page

Parameters

$title
string $id

Returns

string

um_edit_label_all_fields()

um_edit_label_all_fields(  $label,   $data) : string

Field is required?

Parameters

$label
$data

Returns

string

um_edit_my_profile_cancel_uri()

um_edit_my_profile_cancel_uri(string  $url = '') : mixed|string|void

Remove edit profile args from url

Parameters

string $url

Returns

mixed|string|void

um_edit_profile_url()

um_edit_profile_url() : mixed|string|void

Returns the edit profile link

Returns

mixed|string|void

um_edit_url_field_value()

um_edit_url_field_value(  $value,   $key) : string

Cleaning on XSS injection for url editing field

Parameters

$value

string

$key

string

Returns

string —

$value

um_editing_user_id_input()

um_editing_user_id_input(  $args) 

If editing another user

Parameters

$args

um_fetch_user()

um_fetch_user(  $user_id) 

Sets a specific user and prepares profile data and user permissions and makes them accessible.

Parameters

$user_id

(numeric) (required) A user ID is required. This is the user's ID that you wish to set/retrieve

Examples

example below will set user ID 5 prior to retrieving his profile information. <?php um_fetch_user(5); echo um_user('display_name'); // returns the display name of user ID 5 ?>
** File not found : The **
the following example you can fetch the profile of a logged-in user dynamically. <?php um_fetch_user( get_current_user_id() ); echo um_user('display_name'); // returns the display name of logged-in user ?>
** File not found : In **

um_field_conditions_are_met()

um_field_conditions_are_met(  $data) : boolean

If conditions are met return true;

Parameters

$data

Returns

boolean

um_field_non_utf8_value()

um_field_non_utf8_value(string  $value) : string

Filter non-UTF8 strings

Parameters

string $value

Returns

string

um_filter_search()

um_filter_search(string  $search) : string

Filters the search query.

Parameters

string $search

Returns

string

um_filtered_social_link()

um_filtered_social_link(  $key,   $match) : mixed|string|void

Show filtered social link

Parameters

$key
$match

Returns

mixed|string|void

um_filtered_value()

um_filtered_value(  $key, boolean  $data = false) : mixed|string|void

Get filtered meta value after applying hooks

Parameters

$key
boolean $data

Returns

mixed|string|void

um_force_admin_bar()

um_force_admin_bar() 

Fix permission for admin bar

um_force_utf8_fields()

um_force_utf8_fields(mixed  $value, array  $data, string  $type = '') : mixed

Force fields to use UTF-8 encoding

Parameters

mixed $value
array $data
string $type

Returns

mixed

um_force_utf8_string()

um_force_utf8_string(mixed  $value) : mixed

Force strings to UTF-8 encoded

Parameters

mixed $value

Returns

mixed

um_get_avatar()

um_get_avatar(string  $avatar = '', string  $id_or_email = '', string  $size = '96', string  $avatar_class = '', string  $default = '', string  $alt = '') : string

Get user UM avatars

Parameters

string $avatar
string $id_or_email
string $size
string $avatar_class
string $default
string $alt

Returns

string —

returns avatar in image html elements

um_get_avatar_uri()

um_get_avatar_uri(  $image,   $attrs) : boolean|string

get avatar uri

Parameters

$image
$attrs

Returns

boolean|string

um_get_avatar_url()

um_get_avatar_url(  $get_avatar) : mixed

get avatar URL instead of image

Parameters

$get_avatar

Returns

mixed

um_get_core_page()

um_get_core_page(  $slug, boolean  $updated = false) : boolean|false|mixed|string|void

Get core page url

Parameters

$slug
boolean $updated

Returns

boolean|false|mixed|string|void

um_get_cover_uri()

um_get_cover_uri(  $image,   $attrs) : boolean|string

get cover uri

Parameters

$image
$attrs

Returns

boolean|string

um_get_current_page_type()

um_get_current_page_type() : string

Get current page type

Returns

string

um_get_custom_field_array()

um_get_custom_field_array(  $array,   $fields) : mixed

Validate conditional logic

Parameters

$array
$fields

Returns

mixed

um_get_default_avatar_uri()

um_get_default_avatar_uri() : string

Default avatar URL

Returns

string

um_get_default_cover_uri()

um_get_default_cover_uri() : mixed|string|void

default cover

Returns

mixed|string|void

um_get_display_name()

um_get_display_name(  $user_id) : string

Get a user's display name

Parameters

$user_id

Returns

string

um_get_domain_protocol()

um_get_domain_protocol() : string

Get server protocol

Returns

string

um_get_form_fields()

um_get_form_fields(  $array) : mixed|string

Get form fields

Parameters

$array

Returns

mixed|string

um_get_host()

um_get_host() : mixed

Get user host

Returns the webhost this site is using if possible

Returns

mixed —

string $host if detected, false otherwise

um_get_locale()

um_get_locale() : string

Get localization

Returns

string

um_get_metadefault()

um_get_metadefault(  $id) : string

Get meta option default

Parameters

$id

Returns

string

um_get_option()

um_get_option(  $option_id) : mixed|string|void

Get option value

Please use UM()->options()->get() instead

Parameters

$option_id

Returns

mixed|string|void

um_get_redirect_url()

um_get_redirect_url(string  $key) : string

Set redirect key

Parameters

string $key

Returns

string —

$redirect_key

um_get_requested_user()

um_get_requested_user() : boolean|null

Gets the requested user

Returns

boolean|null

um_get_roles()

um_get_roles() : array

Get all UM roles in array

Returns

array

um_get_search_form()

um_get_search_form() : string

Returns the ultimate member search form

Returns

string

um_get_search_query()

um_get_search_query() : string

Returns the user search query

Returns

string

um_get_snippet()

um_get_snippet(  $str, integer  $wordCount = 10) : string

Get limit of words from sentence

Parameters

$str
integer $wordCount

Returns

string

um_get_url_for_language()

um_get_url_for_language(  $post_id,   $language) : boolean|false|string

Get a translated core page URL

Parameters

$post_id
$language

Returns

boolean|false|string

um_get_user_avatar_url()

um_get_user_avatar_url() : boolean|string

get user avatar url

Returns

boolean|string

um_hide_metabox_restrict_content_shop()

um_hide_metabox_restrict_content_shop(  $hide) : boolean

Parameters

$hide

Returns

boolean

um_is_core_page()

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'

Parameters

string $page

UM core page slug

Returns

boolean

um_is_core_post()

um_is_core_post(  $post,   $core_page) : boolean

Parameters

$post
$core_page

Returns

boolean

um_is_core_uri()

um_is_core_uri() : boolean

Is core URL

Returns

boolean

um_is_meta_value_exists()

um_is_meta_value_exists(string  $key, mixed  $value, mixed  $return_user_id = false) : integer

Check if meta_value exists

Parameters

string $key
mixed $value
mixed $return_user_id

Returns

integer

um_is_myprofile()

um_is_myprofile() : boolean

Check if user is in his profile

Returns

boolean

um_is_on_edit_profile()

um_is_on_edit_profile() : boolean

boolean for profile edit page

Returns

boolean

um_is_selected_filter_value()

um_is_selected_filter_value(mixed  $value) : mixed

Filter profile data value

Parameters

mixed $value

Returns

mixed

um_is_session_started()

um_is_session_started() : boolean

Checks if session has been started

Returns

boolean

um_is_temp_image()

um_is_temp_image(  $url) : boolean|string

Check that temp image is valid

Parameters

$url

Returns

boolean|string

um_is_temp_upload()

um_is_temp_upload(  $url) : boolean|string

Check that temp upload is valid

Parameters

$url

Returns

boolean|string

um_is_user_himself()

um_is_user_himself() : boolean

boolean check for not same user

Returns

boolean

um_js_redirect()

um_js_redirect(  $url) 

Parameters

$url

um_let_to_num()

um_let_to_num(string  $v) : integer|string

Let To Num

Does Size Conversions

Parameters

string $v

Returns

integer|string

um_logout_user_links()

um_logout_user_links(  $args) 

Adds main links to a logout widget

Parameters

$args

um_mail_content_type()

um_mail_content_type(  $content_type) : string

Parameters

$content_type

Returns

string

um_members()

um_members(  $argument) : mixed

Get members to show in directory

Parameters

$argument

Returns

mixed

um_members_directory_display()

um_members_directory_display(  $args) 

Member Directory Display

Parameters

$args

um_members_directory_head()

um_members_directory_head(  $args) 

Member Directory Header

Parameters

$args

um_members_directory_pagination()

um_members_directory_pagination(  $args) 

Member Directory Pagination

Parameters

$args

um_members_directory_search()

um_members_directory_search(  $args) 

Member Directory Search

Parameters

$args

um_modify_sortby_randomly()

um_modify_sortby_randomly(  $query) : mixed

Sorting random

Parameters

$query

Returns

mixed

um_multisite_urls_support()

um_multisite_urls_support(  $dir) : string

Support multisite

Parameters

$dir

Returns

string

um_option_match_callback_view_field()

um_option_match_callback_view_field(  $value,   $data) : string

Pair dropdown/multi-select options from a callback function

Parameters

$value

string

$data

array

Returns

string

um_post_registration_approved_hook()

um_post_registration_approved_hook(  $user_id,   $args) 

Account automatically approved

Parameters

$user_id
$args

um_post_registration_checkmail_hook()

um_post_registration_checkmail_hook(  $user_id,   $args) 

Account needs email validation

Parameters

$user_id
$args

um_post_registration_pending_hook()

um_post_registration_pending_hook(  $user_id,   $args) 

Account needs admin review

Parameters

$user_id
$args

um_pre_directory_shortcode()

um_pre_directory_shortcode(  $args) 

Pre-display Member Directory

Parameters

$args

um_pre_profile_shortcode()

um_pre_profile_shortcode(  $args) 

Adds profile permissions to view/edit

Parameters

$args

um_prepare_user_query_args()

um_prepare_user_query_args(  $query_args,   $args) : mixed

Adds main parameters

Parameters

$query_args
$args

Returns

mixed

um_prepare_user_results_array()

um_prepare_user_results_array(  $result) : mixed

Hook in the member results array

Parameters

$result

Returns

mixed

um_pretty_number_formatting()

um_pretty_number_formatting(  $count) : string

Formats numbers nicely

Parameters

$count

Returns

string

um_profile()

um_profile(  $key) : mixed|void

Load profile key

Parameters

$key

Returns

mixed|void

um_profile_content_main()

um_profile_content_main(  $args) 

Um_profile_content_{main_tab}

Parameters

$args

um_profile_dynamic_meta_desc()

um_profile_dynamic_meta_desc() 

Meta description

um_profile_field__select_translate()

um_profile_field__select_translate(  $value,   $data) : string

Apply textdomain in select/multi-select options

Parameters

$value

string

$data

array

Returns

string

um_profile_field_filter_hook__()

um_profile_field_filter_hook__(  $value,   $data, string  $type = '') : string

Global sanitize

Parameters

$value
$data
string $type

Returns

string

um_profile_field_filter_hook__date()

um_profile_field_filter_hook__date(  $value,   $data) : string

Date field

Parameters

$value
$data

Returns

string

um_profile_field_filter_hook__file()

um_profile_field_filter_hook__file(  $value,   $data) : string|void

File field

Parameters

$value
$data

Returns

string|void

um_profile_field_filter_hook__googlemap()

um_profile_field_filter_hook__googlemap(  $value,   $data) : string

Outputs a google map

Parameters

$value
$data

Returns

string

um_profile_field_filter_hook__image()

um_profile_field_filter_hook__image(  $value,   $data) : string

Image field

Parameters

$value
$data

Returns

string

um_profile_field_filter_hook__last_login()

um_profile_field_filter_hook__last_login(  $value,   $data) : string

Last login date

Parameters

$value
$data

Returns

string

um_profile_field_filter_hook__soundcloud_track()

um_profile_field_filter_hook__soundcloud_track(  $value,   $data) : string|void

Outputs a soundcloud track

Parameters

$value
$data

Returns

string|void

um_profile_field_filter_hook__textarea()

um_profile_field_filter_hook__textarea(  $value,   $data) : mixed|string|void

URLs in textarea

Parameters

$value
$data

Returns

mixed|string|void

um_profile_field_filter_hook__time()

um_profile_field_filter_hook__time(  $value,   $data) : mixed|string

Time field

Parameters

$value
$data

Returns

mixed|string

um_profile_field_filter_hook__user_registered()

um_profile_field_filter_hook__user_registered(  $value,   $data) : false|integer|string

User's registration date

Parameters

$value
$data

Returns

false|integer|string

um_profile_field_filter_hook__vimeo_video()

um_profile_field_filter_hook__vimeo_video(  $value,   $data) : integer|string

Outputs a vimeo video

Parameters

$value
$data

Returns

integer|string

um_profile_field_filter_hook__youtube_video()

um_profile_field_filter_hook__youtube_video(  $value,   $data) : boolean|string

Outputs a youtube video

Parameters

$value
$data

Returns

boolean|string

um_profile_field_filter_xss_validation()

um_profile_field_filter_xss_validation(  $value,   $data, string  $type = '') : string

Cleaning on XSS injection

Parameters

$value

string

$data

array

string $type

Returns

string —

$value

um_profile_header()

um_profile_header(  $args) 

Profile header

Parameters

$args

um_profile_header_cover_area()

um_profile_header_cover_area(  $args) 

Profile header cover

Parameters

$args

um_profile_id()

um_profile_id() : boolean|integer|null

Returns

boolean|integer|null

um_profile_menu()

um_profile_menu(array  $args) 

Display the available profile tabs

Parameters

array $args

um_queried_search_value()

um_queried_search_value(  $filter, boolean  $echo = true) : mixed|string

Check value of queried search in text input

Parameters

$filter
boolean $echo

Returns

mixed|string

um_queried_user()

um_queried_user() : mixed

Gets the queried user

Returns

mixed

um_query_args_gender__filter()

um_query_args_gender__filter(array  $field_query) : array

Filter gender query argument

Parameters

array $field_query

Returns

array

um_redirect_home()

um_redirect_home() 

Exit and redirect to home

um_registration_save_files()

um_registration_save_files(  $user_id,   $args) 

Saving files to register a new user, if there are fields with files

Parameters

$user_id
$args

um_registration_set_profile_full_name()

um_registration_set_profile_full_name(  $user_id,   $args) 

Update user Full Name

Parameters

$user_id
$args

um_remove_option()

um_remove_option(  $option_id) 

Update option value

Please use UM()->options()->remove() instead

Parameters

$option_id

um_remove_special_users_from_list()

um_remove_special_users_from_list(  $query_args,   $args) : mixed

Remove users we do not need to show in directory

Parameters

$query_args
$args

Returns

mixed

um_remove_unused_uploads()

um_remove_unused_uploads(  $user_id,   $post_array) 

Clean user temp uploads

Parameters

$user_id
$post_array

um_requesting_password_change()

um_requesting_password_change() : boolean

Check if a legitimate password change request is in action

Returns

boolean

um_requesting_password_reset()

um_requesting_password_reset() : boolean

Check if a legitimate password reset request is in action

Returns

boolean

um_reset_password_errors_hook()

um_reset_password_errors_hook(  $args) 

Error handler: reset password

Parameters

$args

um_reset_password_form()

um_reset_password_form(  $args) 

Form content

Parameters

$args

um_reset_password_page_hidden_fields()

um_reset_password_page_hidden_fields(  $args) 

Hidden fields

Parameters

$args

um_reset_password_process_hook()

um_reset_password_process_hook(  $args) 

Process a new request

Parameters

$args

um_reset_user()

um_reset_user() 

Clears the user data. If a user is logged in, the user data will be reset to that user's data

Examples

can reset user data by using the following line in your code <?php um_reset_user(); ?>
** File not found : You **

um_reset_user_clean()

um_reset_user_clean() 

Clears the user data. You need to fetch a user manually after using this function.

Examples

can reset user data by using the following line in your code <?php um_reset_user_clean(); ?>
** File not found : You **

um_restore_default_roles()

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)

Parameters

$user_id
$args
$to_update

um_search_form()

um_search_form() 

Display the search form.

um_search_select_fields()

um_search_select_fields(  $atts) : array

Retrieves search filter options from a callback

Parameters

$atts

array

Returns

array

um_search_usernames_emails()

um_search_usernames_emails(  $query_args,   $args) : mixed

WP API user search

Parameters

$query_args
$args

Returns

mixed

um_secure_media_uri()

um_secure_media_uri(string  $url) : string

Set SSL to media URI

Parameters

string $url

Returns

string

um_select_dropdown_dynamic_callback_options()

um_select_dropdown_dynamic_callback_options(  $options,   $data) : array

Returns dropdown/multi-select options from a callback function

Parameters

$options

array

$data

array

Returns

array

um_select_dropdown_dynamic_options_to_utf8()

um_select_dropdown_dynamic_options_to_utf8(array  $options, array  $data) : array

Filter select dropdown to use UTF-8 encoding

Parameters

array $options
array $data

Returns

array

um_select_if_in_query_params()

um_select_if_in_query_params(  $filter,   $val) 

Check whether item in dropdown is selected in query-url

Parameters

$filter
$val

um_send_password_change_email()

um_send_password_change_email(  $args) : boolean

Overrides password changed notification

Parameters

$args

Returns

boolean

um_send_registration_notification()

um_send_registration_notification(  $user_id,   $args) 

Send notification about registration

Parameters

$user_id
$args

um_set_redirect_url()

um_set_redirect_url(string  $url) : string

Set redirect key

Parameters

string $url

Returns

string —

$redirect_key

um_set_requested_user()

um_set_requested_user(  $user_id) 

Sets the requested user

Parameters

$user_id

um_social_links_icons()

um_social_links_icons(  $args) 

Show social links as icons below profile name

Parameters

$args

um_sortby_last_login()

um_sortby_last_login(  $query_args,   $sortby) : mixed

Sorting by last login date

Parameters

$query_args
$sortby

Returns

mixed

um_store_lastlogin_timestamp()

um_store_lastlogin_timestamp(  $user_id) 

Store last login timestamp

Parameters

$user_id

um_store_lastlogin_timestamp_()

um_store_lastlogin_timestamp_(  $login) 

Parameters

$login

um_styling_defaults()

um_styling_defaults(  $mode) : array

Get styling defaults

Parameters

$mode

Returns

array

um_submit_account_details()

um_submit_account_details(  $args) 

Submit account page changes

Parameters

$args

um_submit_account_errors_hook()

um_submit_account_errors_hook(  $args) 

Validate for errors in account form

Parameters

$args

um_submit_form_data_role_fields()

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

Parameters

$post_form

array

$mode

Returns

\$post_form

um_submit_form_errors_hook()

um_submit_form_errors_hook(  $args) 

Error handling

Parameters

$args

um_submit_form_errors_hook_()

um_submit_form_errors_hook_(  $args) 

Error processing hook : standard

Parameters

$args

um_submit_form_errors_hook__blockedemails()

um_submit_form_errors_hook__blockedemails(  $args) 

Error handling: blocked emails

Parameters

$args

um_submit_form_errors_hook__blockedips()

um_submit_form_errors_hook__blockedips(  $args) 

Error handling: blocked IPs

Parameters

$args

um_submit_form_errors_hook__blockedwords()

um_submit_form_errors_hook__blockedwords(  $args) 

Error handling: blocked words during sign up

Parameters

$args

um_submit_form_errors_hook_login()

um_submit_form_errors_hook_login(  $args) 

Error procesing hook for login

Parameters

$args

um_submit_form_errors_hook_logincheck()

um_submit_form_errors_hook_logincheck(  $args) 

Login checks thru the frontend login

Parameters

$args

um_submit_form_login()

um_submit_form_login(  $args) 

Form processing

Parameters

$args

um_submit_form_profile()

um_submit_form_profile(  $args) 

Form processing

Parameters

$args

um_submit_form_register()

um_submit_form_register(  $args) : boolean|integer|\WP_Error

Registration form submit handler

Parameters

$args

Returns

boolean|integer|\WP_Error

um_submitting_account_page()

um_submitting_account_page() : boolean

boolean for account page editing

Returns

boolean

um_time_diff()

um_time_diff(  $time1,   $time2) : mixed|void

Get core page url

Parameters

$time1
$time2

Returns

mixed|void

um_trim_string()

um_trim_string(  $s, integer  $length = 20) : string

Trim string by char length

Parameters

$s
integer $length

Returns

string

um_update_option()

um_update_option(  $option_id,   $value) 

Update option value

Please use UM()->options()->update() instead

Parameters

$option_id
$value

um_update_profile_full_name()

um_update_profile_full_name(  $user_id,   $changes) 

Profile name update

Parameters

$user_id
$changes

um_user()

um_user(  $data, null  $attrs = null) : string

Parameters

$data
null $attrs

Returns

string

um_user_edit_profile()

um_user_edit_profile(array  $args) 

Update user's profile

Parameters

array $args

um_user_ip()

um_user_ip() : string

Returns

string —

The user's IP address.

Examples

example below can retrieve the user's IP address <?php $user_ip = um_user_ip(); echo 'User IP address is: ' . $user_ip; // prints the user IP address e.g. 127.0.0.1 ?>
** File not found : The **

um_user_last_login()

um_user_last_login(  $user_id) : mixed|string|void

Get user's last login (time diff)

Parameters

$user_id

Returns

mixed|string|void

um_user_last_login_date()

um_user_last_login_date(  $user_id) : string

Get user's last login time

Parameters

$user_id

Returns

string

um_user_last_login_timestamp()

um_user_last_login_timestamp(  $user_id) : mixed|string

Get user's last login timestamp

Parameters

$user_id

Returns

mixed|string

um_user_login()

um_user_login(array  $args) 

Login user process

Parameters

array $args

um_user_profile_url()

um_user_profile_url(integer|boolean  $user_id = false) : boolean|string

Display a link to profile page

Parameters

integer|boolean $user_id

Returns

boolean|string

um_user_submitted_registration()

um_user_submitted_registration(boolean  $style = false) : null|string

Get submitted user information

Parameters

boolean $style

Returns

null|string

um_user_uploads_dir()

um_user_uploads_dir() : string

user uploads directory

Returns

string

um_user_uploads_uri()

um_user_uploads_uri() : string

user uploads uri

Returns

string

um_whitelisted_wpadmin_access()

um_whitelisted_wpadmin_access(  $allowed) : integer

Filter to allow whitelisted IP to access the wp-admin login

Parameters

$allowed

Returns

integer

um_wp_form_errors_hook_ip_test()

um_wp_form_errors_hook_ip_test(  $user,   $username,   $password) : mixed

Check for blocked ip

Parameters

$user
$username
$password

Returns

mixed

um_wp_form_errors_hook_logincheck()

um_wp_form_errors_hook_logincheck(  $user,   $username,   $password) : \WP_Error|\WP_User

Login checks thru the wordpress admin login

Parameters

$user
$username
$password

Returns

\WP_Error|\WP_User

um_youtube_id_from_url()

um_youtube_id_from_url(  $url) : boolean

Get youtube video ID from url

Parameters

$url

Returns

boolean