API Documentation
\
um
admin
core
core
lib
mobiledetect
widgets

\UM

Main UM Class

Summary

Methods
Properties
Constants
__construct()
is_request()
get_ajax_route()
init_variables()
tooltip()
excluded_taxonomies()
get_template()
locate_template()
instance()
__call()
set_class()
__clone()
__wakeup()
old_extensions_notice()
um__autoloader()
activation()
includes()
common()
external_integrations()
options()
plugin_updater()
ajax_init()
admin()
admin_menu()
admin_settings()
admin_upgrade()
columns()
admin_enqueue()
functions()
metabox()
notices()
users()
builder()
dragdrop()
admin_forms()
admin_forms_settings()
dependencies()
config()
rest_api()
rewrite()
setup()
fonticons()
login()
register()
enqueue()
shortcodes()
account()
password()
form()
fields()
user()
roles()
user_posts()
profile()
query()
datetime()
chart()
builtin()
files()
validation()
access()
permalinks()
mail()
members()
logout()
modal()
cron()
tracking()
mobile()
init()
widgets_init()
bbPress_API()
Followers_API()
Friends_API()
Instagram_API()
Invitations_API()
Mailchimp_API()
Messaging_API()
myCRED_API()
Notices_API()
Notifications_API()
Online_API()
Profile_Completeness_API()
reCAPTCHA_API()
Reviews_API()
Activity_API()
Social_Login_API()
User_Tags_API()
Verified_Users_API()
WooCommerce_API()
Terms_Conditions_API()
Private_Content_API()
User_Location_API()
$options
$screenload_flags
$classes
$is_filtering
$available_languages
No constants found
No protected methods found
$instance
N/A
No private methods found
No private properties found
N/A

Properties

$options

$options :

Type

$screenload_flags

$screenload_flags : array

Type

array — variable for Flags

$classes

$classes : array

Type

array — all plugin's classes

$is_filtering

$is_filtering : boolean

Type

boolean — Old variable

$available_languages

$available_languages : array

Type

array — Languages

$instance

$instance : \UM

Type

\UM — the single instance of the class

Methods

__construct()

__construct()

UM constructor.

is_request()

is_request(string  $type) : boolean

What type of request is this?

Parameters

string $type

String containing name of request type (ajax, frontend, cron or admin)

Returns

boolean

get_ajax_route()

get_ajax_route(string  $route, string  $method) : string

Get ajax routed URL

Parameters

string $route
string $method

Returns

string

init_variables()

init_variables()

Set variables

tooltip()

tooltip(string  $tip, boolean  $allow_html = false, boolean  $echo = true) : string

Help Tip displaying

Function for render/displaying UltimateMember help tip

Parameters

string $tip

Help tip text
boolean $allow_html

Allow sanitized HTML if true or escape
boolean $echo

Return HTML or echo

Returns

string

excluded_taxonomies()

excluded_taxonomies() : mixed|void

Returns

mixed|void

get_template()

get_template(string  $template_name, string  $basename = '', array  $t_args = array(), boolean  $echo = false) : string|void

Output templates

Parameters

string $template_name
string $basename

(default: '')
array $t_args

(default: array())
boolean $echo

Returns

string|void

locate_template()

locate_template(string  $template_name, string  $path = '') : string

Locate a template and return the path for inclusion.

Parameters

string $template_name
string $path

(default: '')

Returns

string

instance()

instance() : \UM

Main UM Instance

Ensures only one instance of UM is loaded or can be loaded.

Returns

\UM —
  • Main instance

__call()

__call(  $name, array  $params) : mixed

Create plugin classes - not sure if it needs!!!!!!!!!!!!!!!

Parameters

$name
array $params

Returns

mixed

set_class()

set_class(string  $class_name, boolean  $instance = false)

Function for add classes to $this->classes for run using UM()

Parameters

string $class_name
boolean $instance

__clone()

__clone()

Cloning is forbidden.

__wakeup()

__wakeup()

Unserializing instances of this class is forbidden.

old_extensions_notice()

old_extensions_notice()

Show notice for customers with old extension's versions

um__autoloader()

um__autoloader(  $class)

Autoload UM classes handler

Parameters

$class

activation()

activation()

Plugin Activation

includes()

includes() : void

Include required core files used in admin and on the frontend.

common()

common() : \um\core\Common()

Returns

\um\core\Common()

external_integrations()

external_integrations() : \um\core\External_Integrations()

Returns

\um\core\External_Integrations()

options()

options() : \um\core\Options()

Returns

\um\core\Options()

plugin_updater()

plugin_updater() : \um\core\Plugin_Updater()

Returns

\um\core\Plugin_Updater()

ajax_init()

ajax_init()

admin()

admin() : \um\admin\Admin()

Returns

\um\admin\Admin()

admin_menu()

admin_menu() : \um\admin\core\Admin_Menu()

Returns

\um\admin\core\Admin_Menu()

admin_settings()

admin_settings() : \um\admin\core\Admin_Settings()

Returns

\um\admin\core\Admin_Settings()

admin_upgrade()

admin_upgrade() : \um\admin\core\Admin_Upgrade()

Returns

\um\admin\core\Admin_Upgrade()

columns()

columns() : \um\admin\core\Admin_Columns()

Returns

\um\admin\core\Admin_Columns()

admin_enqueue()

admin_enqueue() : \um\admin\core\Admin_Enqueue()

Returns

\um\admin\core\Admin_Enqueue()

functions()

functions() : \um\admin\core\Admin_Functions()

Returns

\um\admin\core\Admin_Functions()

metabox()

metabox() : \um\admin\core\Admin_Metabox()

Returns

\um\admin\core\Admin_Metabox()

notices()

notices() : \um\admin\core\Admin_Notices()

Returns

\um\admin\core\Admin_Notices()

users()

users() : \um\admin\core\Admin_Users()

Returns

\um\admin\core\Admin_Users()

builder()

builder() : \um\admin\core\Admin_Builder()

Returns

\um\admin\core\Admin_Builder()

dragdrop()

dragdrop() : \um\admin\core\Admin_DragDrop()

Returns

\um\admin\core\Admin_DragDrop()

admin_forms()

admin_forms(  $data) : \um\admin\core\Admin_Forms()

Parameters

$data

array

Returns

\um\admin\core\Admin_Forms()

admin_forms_settings()

admin_forms_settings(  $data) : \um\admin\core\Admin_Forms_Settings()

Parameters

$data

array

Returns

\um\admin\core\Admin_Forms_Settings()

config()

config() : \um\Config

Returns

\um\Config

init()

init()

Include files with hooked filters/actions

widgets_init()

widgets_init()

Init UM widgets

bbPress_API()

bbPress_API() : \UM_bbPress_API

Returns

\UM_bbPress_API

Followers_API()

Followers_API() : \UM_Followers_API

Returns

\UM_Followers_API

Friends_API()

Friends_API() : \UM_Friends_API

Returns

\UM_Friends_API

Instagram_API()

Instagram_API() : \UM_Instagram_API

Returns

\UM_Instagram_API

Invitations_API()

Invitations_API() : \UM_Invitations_API

Returns

\UM_Invitations_API

Mailchimp_API()

Mailchimp_API() : \UM_Mailchimp_API

Returns

\UM_Mailchimp_API

Messaging_API()

Messaging_API() : \UM_Messaging_API

Returns

\UM_Messaging_API

myCRED_API()

myCRED_API() : \UM_myCRED_API

Returns

\UM_myCRED_API

Notices_API()

Notices_API() : \UM_Notices_API

Returns

\UM_Notices_API

Notifications_API()

Notifications_API() : \UM_Notifications_API

Returns

\UM_Notifications_API

Online_API()

Online_API() : \UM_Online_API

Returns

\UM_Online_API

Profile_Completeness_API()

Profile_Completeness_API() : \UM_Profile_Completeness_API

Returns

\UM_Profile_Completeness_API

reCAPTCHA_API()

reCAPTCHA_API() : \UM_reCAPTCHA_API

Returns

\UM_reCAPTCHA_API

Reviews_API()

Reviews_API() : \UM_Reviews_API

Returns

\UM_Reviews_API

Activity_API()

Activity_API() : \UM_Activity_API

Returns

\UM_Activity_API

Social_Login_API()

Social_Login_API() : \UM_Social_Login_API

Returns

\UM_Social_Login_API

User_Tags_API()

User_Tags_API() : \UM_User_Tags_API

Returns

\UM_User_Tags_API

Verified_Users_API()

Verified_Users_API() : \UM_Verified_Users_API

Returns

\UM_Verified_Users_API

WooCommerce_API()

WooCommerce_API() : \UM_WooCommerce_API

Returns

\UM_WooCommerce_API

Terms_Conditions_API()

Terms_Conditions_API() : \UM_Terms_Conditions_API

Returns

\UM_Terms_Conditions_API

Private_Content_API()

Private_Content_API() : \UM_Private_Content_API

Returns

\UM_Private_Content_API

User_Location_API()

User_Location_API() : \UM_User_Location_API

Returns

\UM_User_Location_API