Ultimate Member - PHPDoc
\
um
admin
core
ajax
common
core
rest
frontend
lib
mobiledetect
widgets

\um\coreShortcodes

Class Shortcodes

Summary

Methods
Properties
Constants
__construct()
display_logout_form()
parse_shortcode_args()
emotize()
is_um_page()
body_class()
core_login_form()
load_template()
get_class()
um_loggedin()
um_loggedout()
author_profile_link()
ultimatemember_login()
ultimatemember_register()
ultimatemember_profile()
ultimatemember_directory()
ultimatemember()
load()
get_css_args()
dynamic_css()
template_load()
template_exists()
get_template_name()
get_templates()
get_shortcode()
get_default_shortcode()
convert_locker_tags()
convert_user_tags()
um_shortcode_show_content_for_role()
ultimatemember_searchform()
add_placeholder()
add_replace_placeholder()
$forms_exist
$profile_role
$message_mode
$custom_message
$loop
$emoji
$form_id
$form_status
$set_args
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$forms_exist

$forms_exist : array

Type

normal

$profile_role

$profile_role : string

Type

normal

$message_mode

$message_mode : bool

Type

normal

$custom_message

$custom_message : string

Type

normal

$loop

$loop : array

Type

normal

$emoji

$emoji : array

Type

normal

$form_id

$form_id : null|int

Type

normal

$form_status

$form_status : null|string

Type

normal

$set_args

$set_args : array

Type

normal

Methods

__construct()

__construct() : mixed

Shortcodes constructor.

Returns

mixed

display_logout_form()

display_logout_form(array  $args) : array

Conditional logout form

Parameters

array $args

Returns

array

parse_shortcode_args()

parse_shortcode_args(array  $args) : array

Filter shortcode args

Parameters

array $args

Returns

array

emotize()

emotize( $content) : mixed|string

Emoji support

Parameters

$content

Returns

mixed|string

is_um_page()

is_um_page() : mixed

Remove wpautop filter for post content if it's UM core page

Returns

mixed

body_class()

body_class(array  $classes) : array

Extend body classes.

Parameters

array $classes

Returns

array

core_login_form()

core_login_form() : int

Retrieve core login form

Returns

int

load_template()

load_template( $tpl) : mixed

Load a compatible template

Parameters

$tpl

Returns

mixed

get_class()

get_class( $mode, array  $args = array()) : mixed|string|void

Add class based on shortcode

Parameters

$mode
array $args

Returns

mixed|string|void

um_loggedin()

um_loggedin(array  $args = array(), string  $content = "") : string

Logged-in only content

Parameters

array $args
string $content

Returns

string

um_loggedout()

um_loggedout(array  $args = array(), string  $content = '') : string

Logged-out only content

Parameters

array $args
string $content

Returns

string

author_profile_link()

author_profile_link(array  $attr = array(), string  $content = '') : string

Display post author's link to UM User Profile.

Parameters

array $attr

{ Attributes of the shortcode.

@type string $class   A link class.
@type string $title   A link text.
@type int    $user_id User ID. Author ID if empty.
@type bool   $raw     Get raw URL or link layout. `false` by default.

}
string $content

Returns

string —

Profile link HTML or profile link URL if the link text is empty.

ultimatemember_login()

ultimatemember_login(array  $args = array()) : string

Parameters

array $args

Returns

string

ultimatemember_register()

ultimatemember_register(array  $args = array()) : string

Parameters

array $args

Returns

string

ultimatemember_profile()

ultimatemember_profile(array  $args = array()) : string

Parameters

array $args

Returns

string

ultimatemember_directory()

ultimatemember_directory(array  $args = array()) : string

Parameters

array $args

Returns

string

ultimatemember()

ultimatemember(array  $args = array()) : string

Shortcode

Parameters

array $args

Returns

string

load()

load( $args) : string

Load a module with global function

Parameters

$args

Returns

string

get_css_args()

get_css_args( $args) : array

Get dynamic CSS args

Parameters

$args

Returns

array

dynamic_css()

dynamic_css(array  $args = array()) : string

Load dynamic CSS.

Parameters

array $args

Returns

string

template_load()

template_load( $template, array  $args = array()) : mixed

Loads a template file

Parameters

$template
array $args

Returns

mixed

template_exists()

template_exists( $template) : bool

Checks if a template file exists

Parameters

$template

Returns

bool

get_template_name()

get_template_name( $file) : mixed|string

Get File Name without path and extension

Parameters

$file

Returns

mixed|string

get_templates()

get_templates(null  $excluded = null) : mixed

Get Templates

Parameters

null $excluded

Returns

mixed

get_shortcode()

get_shortcode( $post_id) : string

Get Shortcode for given form ID

Parameters

$post_id

Returns

string

get_default_shortcode()

get_default_shortcode( $post_id) : string

Get Shortcode for given form ID

Parameters

$post_id

Returns

string

convert_locker_tags()

convert_locker_tags( $str) : mixed|string

Convert access lock tags

Parameters

$str

Returns

mixed|string

convert_user_tags()

convert_user_tags(string  $str) : string

Convert user tags in a string

Parameters

string $str

Returns

string

um_shortcode_show_content_for_role()

um_shortcode_show_content_for_role(array  $atts = array(), string  $content = '') : string

Shortcode: Show custom content to specific role

Show content to specific roles [um_show_content roles='member'] <!-- insert content here --> [/um_show_content] You can add multiple target roles, just use ',' e.g. [um_show_content roles='member,candidates,pets']

Hide content from specific roles [um_show_content not='contributors'] <!-- insert content here --> [/um_show_content] You can add multiple target roles, just use ',' e.g. [um_show_content roles='member,candidates,pets']

Parameters

array $atts
string $content

Returns

string

ultimatemember_searchform()

ultimatemember_searchform(array  $args = array(), string  $content = '') : string

Parameters

array $args
string $content

Returns

string

add_placeholder()

add_placeholder( $placeholders) : array

UM Placeholders for login referrer

Parameters

$placeholders

Returns

array

add_replace_placeholder()

add_replace_placeholder( $replace_placeholders) : array

UM Replace Placeholders for login referrer

Parameters

$replace_placeholders

Returns

array