Ultimate Member - PHPDoc
\
Action_Scheduler
Migration
WP_CLI
um
action_scheduler
admin
core
ajax
common
actions
core
rest
frontend
widgets

\um\coreForm

Class Form

Summary

Methods
Properties
Constants
hooks()
ajax_muted_action()
ajax_select_options()
count_errors()
add_error()
add_notice()
has_error()
has_notice()
get_wp_error()
field_declare()
clean_submitted_data()
form_init()
beautify()
sanitize()
wp_kses_user_desc()
display_form_type()
assigned_role()
form_type()
custom_field_roles()
ignore_formdata_unslash()
$form_data
$form_suffix
$form_id
$form_status
$post_form
$nonce
$errors
$processing
$all_fields
$usermeta_whitelist
No constants found
No protected methods found
No protected properties found
N/A
maybe_apply_tidy()
No private properties found
N/A

Properties

$form_data

$form_data

$form_suffix

$form_suffix

$form_id

$form_id

$form_status

$form_status

$post_form

$post_form : null

Type

normal

$nonce

$nonce : null

Type

normal

$errors

$errors : null|array

Type

normal

$processing

$processing : null

Type

normal

$all_fields

$all_fields : array

Type

normal

$usermeta_whitelist

$usermeta_whitelist : array

Whitelisted usermeta that can be stored when UM Form is submitted.

Type

normal

Methods

hooks()

hooks() : mixed

Hook for singleton

Returns

mixed

ajax_muted_action()

ajax_muted_action() : mixed

Returns

mixed

ajax_select_options()

ajax_select_options() : mixed

Returns

mixed

count_errors()

count_errors() : int

Count the form errors.

Returns

int

add_error()

add_error(string  $key, string  $error) : mixed

Appends field errors

Parameters

string $key
string $error

Returns

mixed

add_notice()

add_notice(string  $key, string  $notice) : mixed

Appends field notices

Parameters

string $key
string $notice

Returns

mixed

has_error()

has_error(string  $key) : bool

If a form has errors

Parameters

string $key

Returns

bool

has_notice()

has_notice(string  $key) : bool

If a form has notices/info

Parameters

string $key

Returns

bool

get_wp_error()

get_wp_error() : \WP_Error

Return the errors as a WordPress Error object

Returns

\WP_Error

field_declare()

field_declare() : mixed

Declare all fields

Returns

mixed

clean_submitted_data()

clean_submitted_data(array  $submitted) : array

Remove banned wp_usermeta keys from submitted data.

Parameters

array $submitted

Returns

array

form_init()

form_init() : mixed

Validate form on submit

Returns

mixed

beautify()

beautify(array  $form) : array

Beautify form data

Parameters

array $form

Returns

array —

$form

sanitize()

sanitize(array  $form) : array

Beautify form data

Parameters

array $form

Returns

array —

$form

wp_kses_user_desc()

wp_kses_user_desc(mixed  $tags, mixed  $context) : mixed

Parameters

mixed $tags
mixed $context

Returns

mixed

display_form_type()

display_form_type(string  $mode, int  $post_id) : string

Display form type as Title

Parameters

string $mode
int $post_id

Returns

string —

$output

assigned_role()

assigned_role(int  $post_id) : string

Assigned roles to a form

Parameters

int $post_id

Returns

string —

$role

form_type()

form_type(int  $post_id) : string

Get form type

Parameters

int $post_id

Returns

string

custom_field_roles()

custom_field_roles(string  $custom_fields) : bool|array

Get custom field roles

Parameters

string $custom_fields

serialized

Returns

bool|array —

roles

ignore_formdata_unslash()

ignore_formdata_unslash(array  $formdata, array  $fields_map) : array

Ignore of `wp_unslash()` for form data

Parameters

array $formdata

The form data to process
array $fields_map

The fields map array

Returns

array —

The updated form data

maybe_apply_tidy()

maybe_apply_tidy(string  $html_fragment, array  $field_data) : string|\tidy

Use PHP tidy extension if it's active for getting clean HTML without unclosed tags.

Parameters

string $html_fragment

Textarea with active HTML option field value.
array $field_data

Ultimate Member form field data.

Returns

string|\tidy