\

account_activation_link_tags_patterns()

account_activation_link_tags_patterns( $placeholders) : array

UM Placeholders for activation link in email

Parameters

Returns

account_activation_link_tags_replaces()

account_activation_link_tags_replaces( $replace_placeholders) : array

UM Replace Placeholders for activation link in email

Parameters

Returns

is_ultimatemember()

is_ultimatemember() : bool

Check if we are on UM page

Returns

ultimatemember_check_username_exists()

ultimatemember_check_username_exists() : bool

Run check if username exists

Returns

um_access_profile()

um_access_profile(int  $user_id) : mixed

Profile Access

Parameters

Returns

um_account_disable_name_fields()

um_account_disable_name_fields(array  $fields) : array

Disables first and last name fields in account page.

Parameters

Returns

um_account_page_hidden_fields()

um_account_page_hidden_fields( $args) : mixed

Hidden inputs for account form

Parameters

Returns

um_account_profile_noindex_value()

um_account_profile_noindex_value(mixed|int  $value) : int

Fix for the account field "Avoid indexing my profile by search engines".

Parameters

Returns

um_account_sanitize_data()

um_account_sanitize_data( $data) : mixed

Sanitize inputs on Account update.

Parameters

Returns

um_account_updated_notification()

um_account_updated_notification( $user_id,  $changed) : mixed

Update Account Email Notification

Parameters

Returns

um_action_request_process()

um_action_request_process() : mixed

Processes the requests of UM actions

Returns

um_add_custom_message_to_menu()

um_add_custom_message_to_menu(array  $sorted_menu_items, \stdClass  $args) : array

Add dynamic profile headers

Parameters

Returns

um_add_edit_icon()

um_add_edit_icon( $args) : mixed

Display the edit profile icon

Parameters

Returns

um_add_form_honeypot_css()

um_add_form_honeypot_css() : mixed

Makes the honeypot invisible

Returns

um_add_form_honeypot_js()

um_add_form_honeypot_js() : mixed

Empty the honeypot value

Returns

um_add_form_identifier()

um_add_form_identifier( $args) : mixed

Adds a form identifier to form

Parameters

Returns

um_add_login_fields()

um_add_login_fields( $args) : mixed

Show Fields

Parameters

Returns

um_add_profile_fields()

um_add_profile_fields( $args) : mixed

Show Fields

Parameters

Returns

um_add_register_fields()

um_add_register_fields( $args) : mixed

Show Fields

Parameters

Returns

um_add_security_checks()

um_add_security_checks( $args) : mixed

Adds a spam timestamp

Parameters

Returns

um_add_submit_button_to_login()

um_add_submit_button_to_login( $args) : mixed

Show the submit button

Parameters

Returns

um_add_submit_button_to_profile()

um_add_submit_button_to_profile( $args) : mixed

Show the submit button (highest priority)

Parameters

Returns

um_add_submit_button_to_register()

um_add_submit_button_to_register( $args) : mixed

Show the submit button

Parameters

Returns

um_add_update_notice()

um_add_update_notice(array  $args) : mixed

Add a notice to UM Form after submission

Parameters

Returns

um_admin_email()

um_admin_email() : mixed|string|void

Short for admin email

Returns

um_admin_user_actions_hook()

um_admin_user_actions_hook(array  $actions, int  $user_id) : array

Main admin user actions.

Parameters

Returns

um_after_account_privacy()

um_after_account_privacy(mixed  $args) : mixed

Parameters

Returns

um_after_insert_user()

um_after_insert_user(int|\WP_Error  $user_id, array  $args, null|array  $form_data = null) : mixed

After insert a new user run at frontend and backend.

Parameters

Returns

um_after_login_submit()

um_after_login_submit( $args) : mixed

Display a forgot password link

Parameters

Returns

um_after_user_account_updated_permalink()

um_after_user_account_updated_permalink(int  $user_id, array  $changes) : mixed

Update Profile URL, display name, full name.

Parameters

Returns

um_allowed_redirect_hosts()

um_allowed_redirect_hosts(array  $hosts) : array

UM allowed hosts

Parameters

Returns

um_avatar_defaults()

um_avatar_defaults( $avatar_defaults) : mixed

Do not apply to backend default avatars

Parameters

Returns

um_before_account_delete()

um_before_account_delete() : mixed

Before delete account tab content

Returns

um_before_account_notifications()

um_before_account_notifications(array  $args = array()) : mixed

Before notifications account tab content.

Parameters

Throws

\Exception

Returns

um_before_update_profile()

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

Filter before update profile to force utf8 strings

Parameters

Returns

um_block_wpadmin_by_user_role()

um_block_wpadmin_by_user_role() : mixed

Checks if user can access the backend

Returns

um_browser_url_redirect_to()

um_browser_url_redirect_to( $args) : mixed

Add a force redirect to from $_get

Parameters

Returns

um_can_edit_field()

um_can_edit_field( $data) : bool

Can edit field

Parameters

Returns

um_can_edit_my_profile()

um_can_edit_my_profile() : bool

Checks if user can edit his profile

Returns

um_can_view_field()

um_can_view_field( $data) : bool

Can view field

Parameters

Returns

um_can_view_profile()

um_can_view_profile(int  $user_id) : bool

Checks if user can view profile

Parameters

Returns

um_change_profile_cover_photo_label()

um_change_profile_cover_photo_label(array  $fields) : array

Add cover photo label of file size limit

Parameters

Returns

um_change_profile_photo_label()

um_change_profile_photo_label(array  $fields) : array

Add profile photo label of file size limit

Parameters

Returns

um_check_conditions_on_submit()

um_check_conditions_on_submit(array  $condition, array  $fields, array  $submitted_data, bool  $reset = false) : bool

Error processing: Conditions

Parameters

Throws

\Exception

Returns

um_check_user_status()

um_check_user_status(int  $user_id, array  $args, null|array  $form_data = null) : mixed

Check user status and redirect it after registration

Parameters

Returns

um_clean_user_basename()

um_clean_user_basename( $value) : mixed|void

User clean basename

Parameters

Returns

um_clean_user_basename_filter()

um_clean_user_basename_filter(string  $value, mixed  $raw) : string

Filter user basename.

Parameters

Returns

um_clickable_links()

um_clickable_links( $s) : mixed

Convert urls to clickable links

Parameters

Returns

um_closest_num()

um_closest_num( $array,  $number) : mixed

Find closest number in an array

Parameters

Returns

um_comment_link_to_profile()

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

Control comment author display.

Parameters

Returns

um_conditional_nav_menu()

um_conditional_nav_menu( $menu_items,  $args) : mixed

Conditional menu items

Parameters

Returns

um_control_admin_bar()

um_control_admin_bar(bool  $show) : bool

Hide admin bar appropriately

Parameters

Returns

um_convert_tags()

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

Convert template tags

Parameters

Returns

um_core_is_local()

um_core_is_local() : bool

Check if running local

Returns

um_custom_wp_err_messages()

um_custom_wp_err_messages( $message) : string

Filter to customize errors

Parameters

Returns

um_deprecated_function()

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

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

Parameters

Returns

um_disable_native_email_notificatiion()

um_disable_native_email_notificatiion( $changed,  $user_id) : mixed

Disable WP native email notification when change email on user account

Parameters

Returns

um_display_login_errors()

um_display_login_errors( $args) : mixed

Display the login errors from other plugins

Parameters

Returns

um_dynamic_login_page_redirect()

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

Get where user should be headed after logging

Parameters

Returns

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

Returns

um_dynamic_user_profile_title()

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

Try and modify the page title in page

Parameters

Returns

um_edit_my_profile_cancel_uri()

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

Remove edit profile args from url

Parameters

Returns

um_edit_profile_url()

um_edit_profile_url(int  $user_id = null) : string

Returns the edit profile link

Parameters

Returns

um_edit_url_field_value()

um_edit_url_field_value( $value,  $key) : string

Cleaning on XSS injection for url editing field

Parameters

Returns

$value

um_editing_user_id_input()

um_editing_user_id_input( $args) : mixed

If editing another user

Parameters

Returns

um_fetch_user()

um_fetch_user( $user_id) : mixed

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

Parameters

Returns

Examples

The 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 ?>

In 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 ?>

um_field_conditions_are_met()

um_field_conditions_are_met( $data) : bool

If conditions are met return true;

Parameters

Returns

um_field_non_utf8_value()

um_field_non_utf8_value(string  $value) : string

Filter non-UTF8 strings

Parameters

Returns

um_filter_get_avatar_url()

um_filter_get_avatar_url(string  $url, int  $id_or_email, array  $args) : string

Replace Gravatar image URL to Ultimate member profile image URL if setting "Use Gravatars?" disabled

Parameters

Returns

um_filter_search()

um_filter_search(string  $search) : string

Filters the search query.

Parameters

Returns

um_filtered_social_link()

um_filtered_social_link(string  $key, null|string  $match = null) : string

Show filtered social link

Parameters

Returns

um_filtered_value()

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

Get filtered meta value after applying hooks

Parameters

Returns

um_force_admin_bar()

um_force_admin_bar() : mixed

Fix permission for admin bar

Returns

um_force_utf8_fields()

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

Force fields to use UTF-8 encoding

Parameters

Returns

um_force_utf8_string()

um_force_utf8_string(mixed  $value) : mixed

Force strings to UTF-8 encoded

Parameters

Returns

um_form_notices_additional_tags()

um_form_notices_additional_tags(array  $allowed_html, string  $context) : array

Extends allowed tags for displaying UM Form notices.

Parameters

Returns

um_form_register_redirect()

um_form_register_redirect() : mixed

Redirect from default registration to UM registration page

Returns

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

Returns

returns avatar in image html elements

um_get_avatar_uri()

um_get_avatar_uri( $image, string|array  $attrs) : bool|string

get avatar uri

Parameters

Returns

um_get_avatar_url()

um_get_avatar_url( $get_avatar) : mixed

get avatar URL instead of image

Parameters

Returns

um_get_canonical_url()

um_get_canonical_url(string  $canonical_url, \WP_Post  $post) : string|bool

Fix SEO canonical for the profile page

Parameters

Returns

The canonical URL, or false if current URL is canonical.

um_get_core_page()

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

Get core page url

Parameters

Returns

um_get_cover_uri()

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

get cover uri

Parameters

Returns

um_get_current_page_type()

um_get_current_page_type() : string

Get current page type

Returns

um_get_custom_field_array()

um_get_custom_field_array( $array,  $fields) : mixed

Validate conditional logic

Parameters

Returns

um_get_default_avatar_uri()

um_get_default_avatar_uri() : string

Default avatar URL

Returns

um_get_default_cover_uri()

um_get_default_cover_uri() : mixed|string|void

default cover

Returns

um_get_display_name()

um_get_display_name( $user_id) : string

Get a user's display name

Parameters

Returns

um_get_domain_protocol()

um_get_domain_protocol() : string

Get server protocol

Returns

um_get_form_fields()

um_get_form_fields(string|array  $array, int  $form_id) : array|string

Get form fields

Parameters

Returns

um_get_host()

um_get_host() : mixed

Get user host

Returns the webhost this site is using if possible

Returns

string $host if detected, false otherwise

um_get_locale()

um_get_locale() : string

Get localization

Returns

um_get_metadefault()

um_get_metadefault( $id) : string

Get meta option default

Parameters

Returns

um_get_nav_menu_items()

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

Conditional menu items

Parameters

Returns

um_get_option()

um_get_option( $option_id) : mixed|string|void

Get option value

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

Parameters

Returns

um_get_predefined_page_id()

um_get_predefined_page_id(string  $slug) : bool|int

Parameters

Returns

um_get_predefined_page_url()

um_get_predefined_page_url(string  $slug) : bool|string

Get predefined page URL

Parameters

Returns

um_get_redirect_url()

um_get_redirect_url(string  $key) : string

Set redirect key

Parameters

Returns

$redirect_key

um_get_requested_user()

um_get_requested_user() : bool|null

Gets the requested user

Returns

um_get_roles()

um_get_roles() : array

Get all UM roles in array

Returns

um_get_search_form()

um_get_search_form() : string

Returns the ultimate member search form

Returns

um_get_search_query()

um_get_search_query() : string

Returns the user search query

Returns

um_get_snippet()

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

Get limit of words from sentence

Parameters

Returns

um_get_url_for_language()

um_get_url_for_language( $post_id,  $language) : bool|string

Get a translated core page URL

Parameters

Returns

um_get_user_avatar_data()

um_get_user_avatar_data( $user_id = '',  $size = '96') : bool|string

get user avatar url

Parameters

Returns

um_get_user_avatar_url()

um_get_user_avatar_url( $user_id = '',  $size = '96') : bool|string

get user avatar url

Parameters

Returns

um_invalid_nonce_redirect_url()

um_invalid_nonce_redirect_url(string  $url) : string

Parameters

Returns

um_is_amp()

um_is_amp(bool  $check_theme_support = true) : bool

Check whether the current page is in AMP mode or not.

We need to check for specific functions, as there is no special AMP header.

Parameters

Returns

um_is_core_page()

um_is_core_page(string  $page) : bool

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

Returns

um_is_core_post()

um_is_core_post( $post,  $core_page) : bool

Parameters

Returns

um_is_core_uri()

um_is_core_uri() : bool

Is core URL

Returns

um_is_file_owner()

um_is_file_owner(string  $url, int|null  $user_id = null, string|bool  $image_path = false) : bool

Check user's file ownership

Parameters

Returns

um_is_meta_value_exists()

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

Check if meta_value exists

Parameters

Returns

um_is_myprofile()

um_is_myprofile() : bool

Check if user is in his profile

Returns

um_is_on_edit_profile()

um_is_on_edit_profile() : bool

boolean for profile edit page

Returns

um_is_predefined_page()

um_is_predefined_page(string  $slug, null|int|\WP_Post  $post = null) : bool

Parameters

Returns

um_is_profile_owner()

um_is_profile_owner( $user_id = false) : bool

Parameters

Returns

um_is_selected_filter_value()

um_is_selected_filter_value(mixed  $value) : mixed

Filter profile data value

Parameters

Returns

um_is_session_started()

um_is_session_started() : bool

Checks if session has been started

Returns

um_is_temp_file()

um_is_temp_file(string  $filename) : bool

Check if file is temporary

Parameters

Returns

um_is_temp_image()

um_is_temp_image( $url) : bool|string

Check that temp image is valid

Parameters

Returns

um_is_temp_upload()

um_is_temp_upload(string  $url) : bool|string

Check that temp upload is valid

Parameters

Returns

um_is_user_himself()

um_is_user_himself() : bool

boolean check for not same user

Returns

um_js_redirect()

um_js_redirect( $url) : mixed

Parameters

Returns

um_let_to_num()

um_let_to_num(string  $v) : int|string

Let To Num

Does Size Conversions

Parameters

Returns

um_logout_user_links()

um_logout_user_links( $args) : mixed

Adds main links to a logout widget

Parameters

Returns

um_lostpassword_url()

um_lostpassword_url(string  $lostpassword_url) : string

Change lost password url in UM Login form

Parameters

Returns

um_mail_content_type()

um_mail_content_type( $content_type) : string

Parameters

Returns

um_maybe_unset_time_limit()

um_maybe_unset_time_limit() : mixed

Maybe set empty time limit

Returns

um_md_label_birth_date()

um_md_label_birth_date(string  $label, string  $key, string  $data) : string

Change field label from "Birth Date" to "Age" in the member directory.

Parameters

Returns

um_members()

um_members( $argument) : mixed

Get members to show in directory

Parameters

Returns

um_multi_admin_email()

um_multi_admin_email() : array

Get admin emails

Returns

um_multisite_urls_support()

um_multisite_urls_support( $dir) : string

Support multisite

Parameters

Returns

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

Returns

um_post_registration_approved_hook()

um_post_registration_approved_hook(int  $user_id) : mixed

Account automatically approved.

Parameters

Returns

um_post_registration_checkmail_hook()

um_post_registration_checkmail_hook(int  $user_id) : mixed

Account needs email validation.

Parameters

Returns

um_post_registration_pending_hook()

um_post_registration_pending_hook(int  $user_id) : mixed

Account needs admin review.

Parameters

Returns

um_pre_profile_shortcode()

um_pre_profile_shortcode(array  $args) : mixed

Adds profile permissions to view/edit.

Parameters

Returns

um_predefined_page_slug_exists()

um_predefined_page_slug_exists(string  $slug) : bool

Parameters

Returns

um_pretty_number_formatting()

um_pretty_number_formatting( $count) : string

Formats numbers nicely

Parameters

Returns

um_profile()

um_profile( $key) : bool|string

Load profile key

Parameters

Returns

um_profile_content_main()

um_profile_content_main(array  $args) : mixed

It renders the content of main profile tab.

Parameters

Returns

um_profile_dynamic_meta_desc()

um_profile_dynamic_meta_desc() : mixed

The profile page SEO tags

Returns

um_profile_field__select_translate()

um_profile_field__select_translate(string  $value, array  $data) : string

Apply textdomain in select/multi-select options

Parameters

Returns

um_profile_field_filter_hook__()

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

Global sanitize

Parameters

Returns

um_profile_field_filter_hook__date()

um_profile_field_filter_hook__date(string  $value, array  $data) : string

Date field.

Parameters

Returns

um_profile_field_filter_hook__file()

um_profile_field_filter_hook__file( $value,  $data) : string

File field

Parameters

Returns

um_profile_field_filter_hook__googlemap()

um_profile_field_filter_hook__googlemap( $value,  $data) : string

Outputs a google map

Parameters

Returns

um_profile_field_filter_hook__image()

um_profile_field_filter_hook__image( $value,  $data) : string

Image field

Parameters

Returns

um_profile_field_filter_hook__last_login()

um_profile_field_filter_hook__last_login( $value,  $data) : string

Last login date

Parameters

Returns

um_profile_field_filter_hook__oembed()

um_profile_field_filter_hook__oembed(string  $value, array  $data) : string

Outputs a oEmbed field

Parameters

Returns

um_profile_field_filter_hook__phone()

um_profile_field_filter_hook__phone( $value,  $data) : int|string

Outputs a phone link

Parameters

Returns

um_profile_field_filter_hook__soundcloud_track()

um_profile_field_filter_hook__soundcloud_track(string  $value, array  $data) : string

Outputs a SoundCloud track

Parameters

Returns

um_profile_field_filter_hook__spotify()

um_profile_field_filter_hook__spotify( $value,  $data) : bool|string

Outputs a spotify iframe

Parameters

Returns

um_profile_field_filter_hook__textarea()

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

URLs in textarea

Parameters

Returns

um_profile_field_filter_hook__time()

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

Time field

Parameters

Returns

um_profile_field_filter_hook__user_registered()

um_profile_field_filter_hook__user_registered( $value,  $data) : bool|int|string

User's registration date

Parameters

Returns

um_profile_field_filter_hook__viber()

um_profile_field_filter_hook__viber( $value,  $data) : int|string

Outputs a viber link

Parameters

Returns

um_profile_field_filter_hook__vimeo_video()

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

Outputs a vimeo video

Parameters

Returns

um_profile_field_filter_hook__whatsapp()

um_profile_field_filter_hook__whatsapp( $value,  $data) : int|string

Outputs a whatsapp link

Parameters

Returns

um_profile_field_filter_hook__youtube_video()

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

Outputs a youtube video

Parameters

Returns

um_profile_field_filter_xss_validation()

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

Cleaning on XSS injection.

Parameters

Returns

um_profile_header()

um_profile_header( $args) : mixed

Profile header

Parameters

Returns

um_profile_header_cover_area()

um_profile_header_cover_area( $args) : mixed

Profile header cover

Parameters

Returns

um_profile_id()

um_profile_id() : int

Returns requested User ID or current User ID

Returns

um_profile_menu()

um_profile_menu(array  $args) : mixed

Display the available profile tabs

Parameters

Returns

um_profile_remove_wpseo()

um_profile_remove_wpseo() : mixed

Remove Yoast from front end for the Profile page

Returns

um_profile_validate_nonce()

um_profile_validate_nonce(array  $submitted_data) : mixed

Validate nonce when profile form submit.

Parameters

Returns

um_queried_search_value()

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

Check value of queried search in text input

Parameters

Returns

um_queried_user()

um_queried_user() : mixed

Gets the queried user

Returns

um_redirect_home()

um_redirect_home(string  $requested_user_id = '', string  $is_my_profile = '') : mixed

Exit and redirect to home

Parameters

Returns

um_registration_save_files()

um_registration_save_files( $user_id,  $args,  $form_data) : mixed

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

Parameters

Returns

um_registration_set_profile_full_name()

um_registration_set_profile_full_name( $user_id,  $args) : mixed

Update user Full Name

Parameters

Returns

um_remove_option()

um_remove_option( $option_id) : mixed

Update option value

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

Parameters

Returns

um_replace_placeholders()

um_replace_placeholders() : array

Getting replace placeholders array

Returns

um_request_user_data()

um_request_user_data() : mixed

Returns

um_requesting_password_change()

um_requesting_password_change() : bool

Check if a legitimate password change request is in action

Returns

um_requesting_password_reset()

um_requesting_password_reset() : bool

Check if a legitimate password reset request is in action

Returns

um_reset_user()

um_reset_user() : mixed

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

Returns

Examples

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

um_reset_user_clean()

um_reset_user_clean() : mixed

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

Returns

Examples

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

um_restore_default_roles()

um_restore_default_roles( $user_id,  $args,  $to_update) : mixed

Leave roles for User, which are not in the list of update profile (are default WP or 3rd plugins roles)

Parameters

Returns

um_safe_redirect()

um_safe_redirect(string  $url) : mixed

UM safe redirect. By default, you can be redirected only to WordPress installation Home URL. Fallback URL is wp-admin URL.

But it can be changed through filters and extended by UM Setting "Allowed hosts for safe redirect (one host per line)" and filter um_wp_safe_redirect_fallback.

Parameters

Returns

um_search_form()

um_search_form() : mixed

Display the search form.

Returns

um_secure_media_uri()

um_secure_media_uri(string  $url) : string

Set SSL to media URI

Parameters

Returns

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

Returns

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

Returns

um_select_if_in_query_params()

um_select_if_in_query_params( $filter,  $val) : mixed

Check whether item in dropdown is selected in query-url

Parameters

Returns

um_send_registration_notification()

um_send_registration_notification( $user_id) : mixed

Send notification about registration

Parameters

Returns

um_set_redirect_url()

um_set_redirect_url(string  $url) : string

Set redirect key

Parameters

Returns

$redirect_key

um_set_requested_user()

um_set_requested_user( $user_id) : mixed

Sets the requested user

Parameters

Returns

um_social_links_icons()

um_social_links_icons( $args) : mixed

Show social links as icons below profile name

Parameters

Returns

um_store_lastlogin_timestamp()

um_store_lastlogin_timestamp( $user_id) : mixed

Store last login timestamp

Parameters

Returns

um_store_lastlogin_timestamp_()

um_store_lastlogin_timestamp_( $login) : mixed

Parameters

Returns

um_styling_defaults()

um_styling_defaults( $mode) : array

Get styling defaults

Parameters

Returns

um_submit_account_details()

um_submit_account_details( $args) : mixed

Submit account page changes

Parameters

Returns

um_submit_account_errors_hook()

um_submit_account_errors_hook(array  $args) : mixed

Validate for errors in account form

Parameters

Returns

um_submit_form_data_role_fields()

um_submit_form_data_role_fields(array  $post_form, string  $mode, array  $all_cf_metakeys) : array

Add `role_select` and `role_radio` to the $post_form It is necessary for that if on these fields the conditional logic.

Parameters

Returns

um_submit_form_data_trim_fields()

um_submit_form_data_trim_fields( $post_form) : mixed

Trim All form POST submitted data

Parameters

Returns

um_submit_form_errors_hook()

um_submit_form_errors_hook(array  $submitted_data, array  $form_data) : mixed

UM login|register|profile form error handling.

Parameters

Returns

um_submit_form_errors_hook_()

um_submit_form_errors_hook_(array  $submitted_data, array  $form_data) : mixed

Error processing hook : standard

Parameters

Returns

um_submit_form_errors_hook__blockedemails()

um_submit_form_errors_hook__blockedemails( $submitted_data) : mixed

Error handling: blocked emails

Parameters

Returns

um_submit_form_errors_hook__blockedips()

um_submit_form_errors_hook__blockedips() : mixed

Error handling: blocked IPs.

Returns

um_submit_form_errors_hook__blockedwords()

um_submit_form_errors_hook__blockedwords(array  $submitted_data, array  $form_data) : mixed

Error handling: blocked words during sign up

Parameters

Returns

um_submit_form_errors_hook__registration()

um_submit_form_errors_hook__registration(array  $submitted_data) : mixed

Validate user password field on registration.

Parameters

Returns

um_submit_form_errors_hook_login()

um_submit_form_errors_hook_login( $submitted_data) : mixed

Error processing hook for login.

Parameters

Returns

um_submit_form_errors_hook_logincheck()

um_submit_form_errors_hook_logincheck(array  $submitted_data, array  $form_data) : mixed

Login checks through the frontend login

Parameters

Returns

um_submit_form_login()

um_submit_form_login(array  $submitted_data, array  $form_data) : mixed

Form processing

Parameters

Returns

um_submit_form_profile()

um_submit_form_profile(array  $args, array  $form_data) : mixed

Form processing

Parameters

Returns

um_submit_form_register()

um_submit_form_register(array  $args, array  $form_data) : mixed

Registration form submit handler.

Parameters

Returns

um_submitting_account_page()

um_submitting_account_page() : bool

boolean for account page editing

Returns

um_time_diff()

um_time_diff( $time1,  $time2) : string

Get core page url

Parameters

Returns

um_trim_string()

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

Trim string by char length

Parameters

Returns

um_update_option()

um_update_option( $option_id,  $value) : mixed

Update option value

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

Parameters

Returns

um_update_profile_full_name()

um_update_profile_full_name( $user_id,  $changes) : mixed

Profile name update

Parameters

Returns

um_upgrade20beta1_copy_email_template()

um_upgrade20beta1_copy_email_template(string  $template) : bool

Ajax copy template to the theme

Parameters

Returns

um_upgrade20beta1_email_templates_process()

um_upgrade20beta1_email_templates_process() : mixed

Transferring email templates to new logic

Returns

um_upgrade20beta1_get_template_file()

um_upgrade20beta1_get_template_file(string  $location, string  $template_name, bool  $html = false) : string

Method returns expected path for template

Parameters

Returns

um_upgrade20beta1_insert_content()

um_upgrade20beta1_insert_content(string  $path, string  $content) : mixed

Insert email template content to file

Parameters

Returns

um_upgrade20beta1_template_in_theme()

um_upgrade20beta1_template_in_theme(string  $template_name, bool  $html = false) : string

Locate a template and return the path for inclusion.

Parameters

Returns

um_upgrade_balance_field215()

um_upgrade_balance_field215() : mixed

Returns

um_upgrade_cache2010()

um_upgrade_cache2010() : mixed

Returns

um_upgrade_choice_callbacks240()

um_upgrade_choice_callbacks240() : mixed

Returns

um_upgrade_content_restriction20beta1()

um_upgrade_content_restriction20beta1() : mixed

Returns

um_upgrade_cpt20beta1()

um_upgrade_cpt20beta1() : mixed

Returns

um_upgrade_email_templates20beta1()

um_upgrade_email_templates20beta1() : mixed

Returns

um_upgrade_fields2044()

um_upgrade_fields2044() : mixed

Returns

um_upgrade_get_forums20beta1()

um_upgrade_get_forums20beta1() : mixed

Returns

um_upgrade_get_products20beta1()

um_upgrade_get_products20beta1() : mixed

Returns

um_upgrade_get_slug2117()

um_upgrade_get_slug2117( $tab) : mixed

Parameters

Returns

um_upgrade_get_users_per_role20beta1()

um_upgrade_get_users_per_role20beta1() : mixed

Returns

um_upgrade_mc_lists20beta1()

um_upgrade_mc_lists20beta1() : mixed

Returns

um_upgrade_memberdir210beta1()

um_upgrade_memberdir210beta1() : mixed

Returns

um_upgrade_menus20beta1()

um_upgrade_menus20beta1() : mixed

Returns

um_upgrade_metadata210beta1()

um_upgrade_metadata210beta1() : mixed

Returns

um_upgrade_metadata_per_user213beta3()

um_upgrade_metadata_per_user213beta3() : mixed

Returns

um_upgrade_metadata_per_user280()

um_upgrade_metadata_per_user280() : mixed

Returns

um_upgrade_metatable213beta3()

um_upgrade_metatable213beta3() : mixed

Returns

um_upgrade_phone_fields250()

um_upgrade_phone_fields250() : mixed

Returns

um_upgrade_profile_tabs2117()

um_upgrade_profile_tabs2117() : mixed

Returns

um_upgrade_reset_password230()

um_upgrade_reset_password230() : mixed

Returns

um_upgrade_roles2054()

um_upgrade_roles2054() : mixed

Returns

um_upgrade_settings20beta1()

um_upgrade_settings20beta1() : mixed

Returns

um_upgrade_skypeid_fields230()

um_upgrade_skypeid_fields230() : mixed

Returns

um_upgrade_social_fields260()

um_upgrade_social_fields260() : mixed

Returns

um_upgrade_social_login20beta1()

um_upgrade_social_login20beta1() : mixed

Returns

um_upgrade_styles2010()

um_upgrade_styles2010() : mixed

Returns

um_upgrade_styles20beta1()

um_upgrade_styles20beta1() : mixed

Returns

um_upgrade_tempfolder2024()

um_upgrade_tempfolder2024() : mixed

Returns

um_upgrade_update_forum_per_page20beta1()

um_upgrade_update_forum_per_page20beta1() : mixed

Returns

um_upgrade_update_options280()

um_upgrade_update_options280() : mixed

Returns

um_upgrade_update_products_per_page20beta1()

um_upgrade_update_products_per_page20beta1() : mixed

Returns

um_upgrade_update_users_per_page20beta1()

um_upgrade_update_users_per_page20beta1() : mixed

Returns

um_upgrade_user_roles20beta1()

um_upgrade_user_roles20beta1() : mixed

Returns

um_upgrade_usermeta_count230()

um_upgrade_usermeta_count230() : mixed

Returns

um_upgrade_usermeta_count280()

um_upgrade_usermeta_count280() : mixed

Returns

um_upgrade_usermeta_part230()

um_upgrade_usermeta_part230() : mixed

Returns

um_upgrade_usermetaquery1339()

um_upgrade_usermetaquery1339() : mixed

Returns

um_upgrade_users_count213beta3()

um_upgrade_users_count213beta3() : mixed

Returns

um_user()

um_user( $data, null  $attrs = null) : int|string|array

Parameters

Returns

um_user_edit_profile()

um_user_edit_profile(array  $args, array  $form_data) : mixed

Update user's profile (frontend).

Parameters

Returns

um_user_ip()

um_user_ip() : string

Returns

The user's IP address.

Examples

The 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 ?>

um_user_last_login()

um_user_last_login(int  $user_id) : string

Get user's last login (time diff)

Parameters

Returns

um_user_last_login_date()

um_user_last_login_date( $user_id) : string

Get user's last login time

Parameters

Returns

um_user_last_login_timestamp()

um_user_last_login_timestamp(int  $user_id) : int|string

Get user's last login timestamp

Parameters

Returns

um_user_login()

um_user_login(array  $submitted_data) : mixed

Login user process.

Parameters

Returns

um_user_profile_url()

um_user_profile_url(int|bool  $user_id = false) : bool|string

Display a link to profile page

Parameters

Returns

um_user_submited_display()

um_user_submited_display(string  $k, string  $title, array  $data = array(), bool  $style = true) : string

Prepare template

Parameters

Returns

um_user_submitted_registration()

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

Get submitted user information

Parameters

Returns

um_user_submitted_registration_formatted()

um_user_submitted_registration_formatted(bool  $style = false) : string

Format submitted data for Info preview & Email template

Parameters

Returns

um_user_uploads_dir()

um_user_uploads_dir() : string

user uploads directory

Returns

um_user_uploads_uri()

um_user_uploads_uri() : string

user uploads uri

Returns

um_view_label_birth_date()

um_view_label_birth_date(string  $label, string  $data) : string

Change field label from "Birth Date" to "Age" in the profile view.

Parameters

Returns

um_wp_form_errors_hook_ip_test()

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

Check for blocked IPs or Email on wp-login.php form

Parameters

Returns

um_wp_form_errors_hook_logincheck()

um_wp_form_errors_hook_logincheck(\WP_Error|\WP_User  $user) : \WP_Error|\WP_User

Login checks through the WordPress admin login.

Parameters

Returns

um_wp_safe_redirect_fallback()

um_wp_safe_redirect_fallback(string  $url, string  $status) : string

UM fallback redirect URL

Parameters

Returns

um_youtube_id_from_url()

um_youtube_id_from_url(string  $url) : bool|string

Get YouTube video ID from URL.

Parameters

Returns