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

\um\coreFields

Class Fields

Summary

Methods
Properties
Constants
__construct()
checkbox()
show_social_urls()
add_hidden_field()
disabled_hidden_field()
globally_update_field()
update_field()
delete_field_from_form()
delete_field_from_db()
aria_valid_attributes()
field_error()
field_notice()
is_error()
is_notice()
show_error()
show_notice()
field_label()
get_class()
field_value()
is_selected()
is_radio_checked()
get_field_icon()
dropdown_options_source_blacklist()
is_source_blacklisted()
get_option_value_from_callback()
get_options_from_callback()
get_field_type()
get_label()
get_field_title()
get_fields()
get_field()
filter_field_non_utf8_value()
get_restricted_fields_for_edit()
edit_field()
get_available_roles()
array_sort_by_column()
get_fields_by_row()
get_fields_in_subrow()
get_fields_in_group()
get_fields_in_column()
display()
view_field()
view_field_output()
display_view()
new_row_output()
do_ajax_action()
get_atts()
$set_mode
$set_id
$editing
$viewing
$timestamp
$global_args
$field_icons
$get_fields
$rows
$fields
$disable_tooltips
No constants found
No protected methods found
No protected properties found
N/A
add_field_from_list()
add_field_from_predefined()
duplicate_field()
No private properties found
N/A

Properties

$set_mode

$set_mode : null|string

Type

normal

$set_id

$set_id : null|int

Type

normal — form_id

$editing

$editing : bool

Type

normal

$viewing

$viewing : bool

Type

normal

$timestamp

$timestamp : int

Type

normal

$global_args

$global_args : array

Type

normal

$field_icons

$field_icons : array

Type

normal

$get_fields

$get_fields : array

Type

normal

$rows

$rows : array

Type

normal

$fields

$fields : array

Type

normal

$disable_tooltips

$disable_tooltips : bool

Type

normal

Methods

__construct()

__construct() : mixed

Fields constructor.

Returns

mixed

checkbox()

checkbox(int  $id, string  $title, bool  $checked = true) : mixed

Standard checkbox field

Parameters

int $id
string $title
bool $checked

Returns

mixed

show_social_urls()

show_social_urls() : mixed

Shows social links.

Returns

mixed

add_hidden_field()

add_hidden_field(string  $field) : mixed

Hidden field inside a shortcode

Parameters

string $field

Returns

mixed

disabled_hidden_field()

disabled_hidden_field(string  $key, string  $value) : string

Get hidden field

Parameters

string $key
string $value

Returns

string

globally_update_field()

globally_update_field(int  $id, array  $args) : mixed

Updates a field globally

Parameters

int $id
array $args

Returns

mixed

update_field()

update_field(int  $id, array  $args, int  $form_id) : mixed

Updates a field in form only

Parameters

int $id
array $args
int $form_id

Returns

mixed

delete_field_from_form()

delete_field_from_form(string  $id, int  $form_id) : mixed

Deletes a field in form only

Parameters

string $id
int $form_id

Returns

mixed

delete_field_from_db()

delete_field_from_db(string  $id) : mixed

Deletes a field from custom fields.

Parameters

string $id

Returns

mixed

aria_valid_attributes()

aria_valid_attributes(bool  $is_error, string  $field_id, mixed  $context = 'error') : string

Generate aria errors attributes.

Parameters

bool $is_error
string $field_id
mixed $context

Returns

string

field_error()

field_error(string  $text, string  $input_id, bool  $force_show = false) : string

Print field error.

Parameters

string $text
string $input_id
bool $force_show

Returns

string

field_notice()

field_notice(string  $text, string  $input_id, bool  $force_show = false) : string

Print field notice.

Parameters

string $text
string $input_id
bool $force_show

Returns

string

is_error()

is_error(string  $key) : bool

Checks if field has a server-side error

Parameters

string $key

Returns

bool

is_notice()

is_notice(string  $key) : bool

Checks if field has a notice

Parameters

string $key

Returns

bool

show_error()

show_error(string  $key) : string

Returns field error

Parameters

string $key

Returns

string

show_notice()

show_notice(string  $key) : string

Returns field notices

Parameters

string $key

Returns

string

field_label()

field_label(string  $label, string  $key, array  $data) : string

Display field label.

Parameters

string $label

Field label.
string $key

Field key.
array $data

Field data.

Returns

string

get_class()

get_class(string  $key, array  $data, string  $add = null) : string

Output field classes.

Parameters

string $key
array $data
string $add

Returns

string

field_value()

field_value(string  $key, bool  $default = false, array  $data = null) : mixed

Gets field value

Parameters

string $key
bool $default
array $data

Returns

mixed

is_selected()

is_selected(string  $key, string  $value, array  $data) : bool

Checks if an option is selected.

is used by Select, Multiselect and Checkbox fields

Parameters

string $key
string $value
array $data

Returns

bool

is_radio_checked()

is_radio_checked(string  $key, string  $value, array  $data) : bool

Checks if a radio button is selected

Parameters

string $key
string $value
array $data

Returns

bool

get_field_icon()

get_field_icon(string  $key) : string

Get field icon

Parameters

string $key

Returns

string

dropdown_options_source_blacklist()

dropdown_options_source_blacklist() : array

Getting the blacklist of the functions that cannot be used as callback.

All internal PHP functions are insecure for using inside callback functions.

Returns

array

is_source_blacklisted()

is_source_blacklisted(string  $source) : bool

Is the dropdown source callback function blacklisted?

Parameters

string $source

Function name

Returns

bool

get_option_value_from_callback()

get_option_value_from_callback(string  $value, array  $data, string  $type) : string

Gets selected option value from a callback function

Parameters

string $value
array $data
string $type

Returns

string

get_options_from_callback()

get_options_from_callback(array  $data, string  $type) : array

Get select options from a callback function

Parameters

array $data
string $type

Returns

array —

$arr_options

get_field_type()

get_field_type(string  $key) : string

Get field type

Parameters

string $key

Returns

string

get_label()

get_label(string  $key) : string

Get field label

Parameters

string $key

Returns

string

get_field_title()

get_field_title(string  $key) : string

Get field title

Parameters

string $key

Returns

string

get_fields()

get_fields() : array

Get form fields

Returns

array

get_field()

get_field( $key) : mixed

Get specific field

Parameters

$key

Throws

\Exception

Returns

mixed

filter_field_non_utf8_value()

filter_field_non_utf8_value( $option_value) : mixed|void

Parameters

$option_value

Returns

mixed|void

get_restricted_fields_for_edit()

get_restricted_fields_for_edit(bool|int  $_um_profile_id = false) : array

Getting the fields that need to be disabled in edit mode (profile)

Parameters

bool|int $_um_profile_id

Returns

array

edit_field()

edit_field(string  $key, array  $data, bool  $rule = false, array  $args = array()) : string|null

Gets a field in 'input mode'

Parameters

string $key
array $data
bool $rule
array $args

Throws

\Exception

Returns

string|null

get_available_roles()

get_available_roles( $form_key, array  $options = array()) : array

Filter for user roles

Parameters

$form_key
array $options

Returns

array

array_sort_by_column()

array_sort_by_column(array  $arr, string  $col, string  $dir = SORT_ASC) : array

Sorts columns array

Parameters

array $arr
string $col
string $dir

Returns

array —

$arr

get_fields_by_row()

get_fields_by_row(int  $row_id) : string

Get fields in row

Parameters

int $row_id

Returns

string

get_fields_in_subrow()

get_fields_in_subrow(string  $row_fields, int  $subrow_id) : mixed

Get fields by sub row

Parameters

string $row_fields
int $subrow_id

Returns

mixed

get_fields_in_group()

get_fields_in_group(int  $group_id) : mixed

Get fields in group

Parameters

int $group_id

Returns

mixed

get_fields_in_column()

get_fields_in_column(array  $fields, int  $col_number) : mixed

Get fields in column

Parameters

array $fields
int $col_number

Returns

mixed

display()

display(string  $mode, array  $args) : string|null

Display fields

Parameters

string $mode
array $args

Throws

\Exception

Returns

string|null

view_field()

view_field(string  $key, array  $data, bool  $rule = false) : string|null

Gets a field in `view mode`

Parameters

string $key
array $data
bool $rule

Throws

\Exception

Returns

string|null

view_field_output()

view_field_output(array  $data) : array

Filter field data

Parameters

array $data

Returns

array

display_view()

display_view(string  $mode, array  $args) : string|null

Display fields ( view mode )

Parameters

string $mode
array $args

Throws

\Exception

Returns

string|null

new_row_output()

new_row_output(string  $row_id, array  $row_array) : string

Get new row in form.

Parameters

string $row_id
array $row_array

Returns

string

do_ajax_action()

do_ajax_action() : mixed

Admin Builder silent AJAX handler for actions with fields.

Returns

mixed

get_atts()

get_atts(string  $key, array  $classes, string  $conditional, array  $data, array  $field_style = array()) : mixed

Get rendered field attributes

Parameters

string $key
array $classes
string $conditional
array $data
array $field_style

Returns

mixed

add_field_from_list()

add_field_from_list(string  $global_id, int  $form_id, array  $position = array()) : mixed

Quickly adds a field from custom fields.

Parameters

string $global_id
int $form_id
array $position

Returns

mixed

add_field_from_predefined()

add_field_from_predefined(string  $global_id, int  $form_id, array  $position = array()) : mixed

Quickly adds a field from pre-defined fields.

Parameters

string $global_id
int $form_id
array $position

Returns

mixed

duplicate_field()

duplicate_field(string  $id, int  $form_id) : mixed

Duplicates a field by meta key.

Parameters

string $id
int $form_id

Returns

mixed