API Documentation
\
um
admin
core
core
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()
ultimatemember()
load()
get_css_args()
dynamic_css()
template_load()
template_exists()
get_template_name()
get_templates()
get_shortcode()
convert_locker_tags()
convert_user_tags()
um_shortcode_show_content_for_role()
ultimatemember_searchform()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct()

Shortcodes constructor.

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()

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

body_class()

body_class(  $classes) : array

Extend body classes

Parameters

$classes

Returns

array

core_login_form()

core_login_form() : integer

Retrieve core login form

Returns

integer

load_template()

load_template(  $tpl)

Load a compatible template

Parameters

$tpl

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(  $args = array(),   $content = "")

Parameters

$args
$content

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())

Loads a template file

Parameters

$template
array $args

template_exists()

template_exists(  $template) : boolean

Checks if a template file exists

Parameters

$template

Returns

boolean

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

convert_locker_tags()

convert_locker_tags(  $str) : mixed|string

Convert access lock tags

Parameters

$str

Returns

mixed|string

convert_user_tags()

convert_user_tags(  $str) : mixed

Convert user tags in a string

Parameters

$str

Returns

mixed

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'] [/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'] [/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