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

\um\coreValidation

Class Validation

Summary

Methods
Properties
Constants
__construct()
validate_files()
validate_fields_values()
get_email_error_message()
remove_html()
normalize()
safe_name_in_url()
strong_pass()
safe_username()
safe_string()
is_phone_number()
is_discord_id()
is_url()
randomize()
generate()
random_number()
validate_date()
$regex_safe
$regex_username_safe
$regex_phone_number
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$regex_safe

$regex_safe : string

Type

normal

$regex_username_safe

$regex_username_safe : string

Type

normal

$regex_phone_number

$regex_phone_number : string

Type

normal

Methods

__construct()

__construct() : mixed

Validation constructor.

Returns

mixed

validate_files()

validate_files( $files) : mixed

Validate files before upload

Parameters

$files

Returns

mixed

validate_fields_values()

validate_fields_values(mixed  $changes, mixed  $args, mixed  $form_data) : mixed

Parameters

mixed $changes
mixed $args
mixed $form_data

Returns

mixed

get_email_error_message()

get_email_error_message(string  $real_message, string  $code, string  $key, array  $attributes, string  $mode) : string

Get a customizable email validation error without exposing its cause by default.

Parameters

string $real_message

Specific, translated error message.
string $code

Stable error identifier.
string $key

Field meta key.
array $attributes

Field attributes.
string $mode

Form mode.

Returns

string

remove_html()

remove_html( $string) : string

Removes HTML from any string

Parameters

$string

Returns

string

normalize()

normalize( $string) : mixed

Normalize a string

Parameters

$string

Returns

mixed

safe_name_in_url()

safe_name_in_url( $name) : mixed|string

Safe name usage ( for url purposes )

Parameters

$name

Returns

mixed|string

strong_pass()

strong_pass(string  $candidate) : bool|string

Password strength test

Parameters

string $candidate

Password candidate to test.

Returns

bool|string —

If password is valid then return true. Otherwise, error message.

safe_username()

safe_username( $string) : bool

Space, dash, underscore

Parameters

$string

Returns

bool

safe_string()

safe_string( $string) : bool

Dash and underscore (metakey)

Parameters

$string

Returns

bool

is_phone_number()

is_phone_number( $string) : bool

Ss phone number

Parameters

$string

Returns

bool

is_discord_id()

is_discord_id( $string) : bool

Is Discord ID?

Parameters

$string

Returns

bool

is_url()

is_url( $url, string|bool  $social = false) : bool

Is url

Parameters

$url
string|bool $social

Allowed social host (also accepts its www variant).

Returns

bool

randomize()

randomize(int  $length = 10) : string

Get a random string

Parameters

int $length

Returns

string

generate()

generate(int  $length = 40) : string

Generate a password, hash, or similar

Parameters

int $length

Returns

string

random_number()

random_number(bool  $len = false) : int|string

Random numbers only

Parameters

bool $len

Returns

int|string

validate_date()

validate_date( $date, string  $format = 'YYYY/MM/D') : bool

To validate given date input

Parameters

$date
string $format

Returns

bool