Constants

BADGE_COLOR

BADGE_COLOR = 'blue'

String of a badge color.

Options: blue, green, red, orange, purple and gray.

Properties

$labels

$labels : array

Array of labels.

Type

normal

Methods

__construct()

__construct() : mixed

Site_Health constructor.

Returns

mixed

get_labels()

get_labels() : array

Return labels array with translations.

Returns

array —

Labels array containing translations.

register_site_status_tests()

register_site_status_tests(array  $tests) : array

Register site status tests.

Parameters

array $tests

The array of site status tests.

Returns

array —

The modified array of site status tests.

override_templates_test()

override_templates_test() : array

Calculates the status of custom Ultimate Member templates and provides a detailed result array.

Returns

array —

Result array containing details about the custom templates status.

outdated_icons_test()

outdated_icons_test() : array

Retrieve information about outdated icons in Ultimate Member forms and settings.

Returns

array —

Information about the status of icons, including label, status, badge, description, actions, and test name.

get_banned_fields()

get_banned_fields() : bool|array

Retrieve information about banned fields in Ultimate Member forms.

Returns

bool|array —

Information about banned fields, including description, actions, and form data.

banned_fields_test()

banned_fields_test() : array

Retrieve information about banned fields in Ultimate Member forms.

Returns

array —

Information about the status of banned fields, including label, status, badge, description, actions, and test name.

debug_information()

debug_information(array  $info) : array

Add our data to Site Health information.

Parameters

array $info

The Site Health information.

Returns

array —

The updated Site Health information.

settings_debug_information()

settings_debug_information() : array

Retrieve debug information for various settings in the application.

Returns

array —

Debug information for general, access, emails, appearance, advanced, and license settings.

general_settings_debug_information()

general_settings_debug_information() : array

Retrieve debug information about general settings in Ultimate Member.

Returns

array —

Information about the general settings including pages, user settings, and related options.

access_settings_debug_information()

access_settings_debug_information() : array

Retrieve debug information related to access settings in Ultimate Member.

Returns

array —

Debug information about access settings, including restrictions, accessible options, and other settings.

emails_settings_debug_information()

emails_settings_debug_information() : array

Retrieve debug information about the email settings in Ultimate Member.

Returns

array —

Information about the email settings, including labels, values, and template status.

appearance_settings_debug_information()

appearance_settings_debug_information() : array

Retrieve debug information related to appearance settings in Ultimate Member.

Returns

array —

Debug information about appearance settings, including profile template, profile photo settings, cover photo settings, and more.

advanced_settings_debug_information()

advanced_settings_debug_information() : array

Retrieve advanced settings debug information for Ultimate Member.

Returns

array —

An array containing detailed information about various advanced settings, including labels and values.

license_settings_debug_information()

license_settings_debug_information() : array

Retrieve license settings debug information for Ultimate Member.

Returns

array —

License settings for Site Health, including label and value.

roles_debug_information()

roles_debug_information(array  $info) : array

Retrieve information about roles and role settings in the site health check.

Parameters

array $info

The existing site health information array.

Returns

array —

Updated site health information including user roles and their settings.

forms_debug_information()

forms_debug_information(array  $info) : array

Retrieve debug information about Ultimate Member forms.

Parameters

array $info

Information array containing debug information.

Returns

array —

Information about Ultimate Member forms including form IDs, titles, settings, and labels.

member_directories_debug_information()

member_directories_debug_information(array  $info) : array

Get information about member directories for site health check.

Parameters

array $info

Additional information for site health check.

Returns

array —

Information about Ultimate Member directories including labels, fields, and debug details.

get_outdated_icons()

get_outdated_icons() : array|bool

Retrieves outdated icons in Ultimate Member forms and provides details and actions for updating.

Returns

array|bool —

Returns an array with description and actions for updating outdated icons, or null if nothing needs updating.

field_is_banned()

field_is_banned(string  $metakey) : bool

Check if a specific field is banned for a user based on the meta key.

Parameters

string $metakey

The meta key to check if it's banned.

Returns

bool —

True if the field is banned, false otherwise.

get_role_meta()

get_role_meta(string  $slug) : mixed|bool

Retrieve role metadata by slug.

Parameters

string $slug

The slug of the role.

Returns

mixed|bool —

Role metadata if found, false if not found.

get_field_data()

get_field_data(string  $field_key, array  $field) : array

Retrieve field data based on the field key and field configuration.

Parameters

string $field_key

The key of the field.

array $field

The configuration of the field.

Returns

array —

Field data including label and value.