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

\um\coreMember_Directory

Class Member_Directory

Summary

Methods
Properties
Constants
__construct()
get_hide_in_members_default()
get_directory_by_hash()
get_directory_hash()
get_type_basename()
convert_tags()
access_members()
before_save_data()
init_variables()
show_filter()
slider_filters_range()
slider_range_placeholder()
datepicker_filters_range()
borndate()
restriction_options()
hide_not_approved()
hide_by_role()
hide_by_account_settings()
general_options()
show_selected_roles()
show_only_with_avatar()
show_only_with_cover()
show_only_these_users()
exclude_these_users()
pagination_options()
sorting_query()
sortby_randomly()
sortby_last_login()
general_search()
filters()
default_filters()
calculate_pagination()
build_user_card_data()
pagination_changes()
search_changes()
predefined_no_caps()
ajax_get_members()
dropdown_menu()
dropdown_menu_js()
default_filter_settings()
get_member_directory_id()
$view_types
$sort_fields
$sort_data_types
$default_sorting
$filter_fields
$searching_fields
$custom_filters_in_query
$filter_supported_fields
$sorting_supported_fields
$filter_types
$core_search_fields
$core_users_fields
$query_args
$cover_size
$avatar_size
$is_search
No constants found
get_core_search_fields()
timepicker_filters_range()
prepare_search()
No protected properties found
N/A
build_user_actions_list()
No private properties found
N/A

Properties

$view_types

$view_types : array

Member Directory Views

Type

normal

$sort_fields

$sort_fields : array

Type

normal

$sort_data_types

$sort_data_types : array

Type

normal

$default_sorting

$default_sorting : array

Type

normal

$filter_fields

$filter_fields : array

Type

normal

$searching_fields

$searching_fields : array

Type

normal

$custom_filters_in_query

$custom_filters_in_query : array

Type

normal

$filter_supported_fields

$filter_supported_fields

$sorting_supported_fields

$sorting_supported_fields

$filter_types

$filter_types

$core_search_fields

$core_search_fields : string[]

Fields used for searching from wp_users table.

Type

normal

$core_users_fields

$core_users_fields : string[]

Fields used for sorting from wp_users table.

Type

normal

$query_args

$query_args

$cover_size

$cover_size : \um\core\User

Type

normal — Card cover size

$avatar_size

$avatar_size : \um\core\User

Type

normal — Avatar size

$is_search

$is_search : bool

Type

normal — Searching marker

Methods

__construct()

__construct() : mixed

Member_Directory constructor.

Returns

mixed

get_hide_in_members_default()

get_hide_in_members_default() : bool

Returns

bool

get_directory_by_hash()

get_directory_by_hash(string  $hash) : bool|int

Getting member directory post ID via hash Hash is unique attr, which we use visible at frontend

Parameters

string $hash

Returns

bool|int

get_directory_hash()

get_directory_hash( $id) : bool|string

Parameters

$id

Returns

bool|string

get_type_basename()

get_type_basename(string  $type) : string

Get view Type template

Parameters

string $type

Returns

string

convert_tags()

convert_tags(string  $string, array  $array) : string

Tag conversion for member directory

Parameters

string $string
array $array

Returns

string

access_members()

access_members() : mixed

Members page allowed?

can be disabled by "Enable Members Directory" option

Returns

mixed

before_save_data()

before_save_data( $value,  $key,  $post_id) : array

Parameters

$value
$key
$post_id

Returns

array

init_variables()

init_variables() : mixed

Returns

mixed

show_filter()

show_filter(string  $filter, array  $directory_data, mixed  $default_value = false, bool  $admin = false) : string

Render member's directory filters selectboxes

Parameters

string $filter
array $directory_data
mixed $default_value
bool $admin

Returns

string —

$filter

slider_filters_range()

slider_filters_range(string  $filter, array  $directory_data) : mixed

Parameters

string $filter
array $directory_data

Returns

mixed

slider_range_placeholder()

slider_range_placeholder( $filter, mixed  $attrs) : mixed

Parameters

$filter
mixed $attrs

Returns

mixed

datepicker_filters_range()

datepicker_filters_range( $filter) : mixed

Parameters

$filter

Returns

mixed

borndate()

borndate( $borndate) : bool|string

Parameters

$borndate

Returns

bool|string

restriction_options()

restriction_options() : mixed

Handle members can view restrictions

Returns

mixed

hide_not_approved()

hide_not_approved() : mixed

Returns

mixed

hide_by_role()

hide_by_role() : mixed

Returns

mixed

hide_by_account_settings()

hide_by_account_settings() : mixed

Returns

mixed

general_options()

general_options(array  $directory_data) : mixed

Handle "General Options" metabox settings

Parameters

array $directory_data

Returns

mixed

show_selected_roles()

show_selected_roles(array  $directory_data) : mixed

Handle "User Roles to Display" option

Parameters

array $directory_data

Returns

mixed

show_only_with_avatar()

show_only_with_avatar(array  $directory_data) : mixed

Handle "Only show members who have uploaded a profile photo" option

Parameters

array $directory_data

Returns

mixed

show_only_with_cover()

show_only_with_cover(array  $directory_data) : mixed

Handle "Only show members who have uploaded a cover photo" option

Parameters

array $directory_data

Returns

mixed

show_only_these_users()

show_only_these_users(array  $directory_data) : mixed

Handle "Only show specific users (Enter one username per line)" option

Parameters

array $directory_data

Returns

mixed

exclude_these_users()

exclude_these_users(array  $directory_data) : mixed

Handle "Exclude specific users (Enter one username per line)" option

Parameters

array $directory_data

Returns

mixed

pagination_options()

pagination_options(array  $directory_data) : mixed

Handle "Pagination Options" metabox settings

Parameters

array $directory_data

Returns

mixed

sorting_query()

sorting_query(array  $directory_data) : mixed

Add sorting attributes for \WP_Users_Query

Parameters

array $directory_data

Member Directory options

Returns

mixed

sortby_randomly()

sortby_randomly(object  $query) : mixed

Sorting random

Parameters

object $query

Returns

mixed

sortby_last_login()

sortby_last_login(object  $query) : mixed

Sorting by last login

Parameters

object $query

Returns

mixed

general_search()

general_search() : mixed

Handle general search line request

Returns

mixed

filters()

filters(mixed  $directory_data) : mixed

Handle filters request

Parameters

mixed $directory_data

Returns

mixed

default_filters()

default_filters( $directory_data) : mixed

Set default filters

Parameters

$directory_data

Returns

mixed

calculate_pagination()

calculate_pagination(array  $directory_data, int  $total_users) : array

Get data array for pagination

Parameters

array $directory_data
int $total_users

Returns

array

build_user_card_data()

build_user_card_data(int  $user_id, array  $directory_data) : array

Parameters

int $user_id
array $directory_data

Returns

array

pagination_changes()

pagination_changes(\WP_User_Query  $user_query) : mixed

Update limit query

Parameters

\WP_User_Query $user_query

Returns

mixed

search_changes()

search_changes(\WP_User_Query  $user_query) : mixed

Update search query

Parameters

\WP_User_Query $user_query

Throws

\Exception

Returns

mixed

predefined_no_caps()

predefined_no_caps(mixed  $directory_data) : mixed

Parameters

mixed $directory_data

Returns

mixed

ajax_get_members()

ajax_get_members() : mixed

Main Query function for getting members via AJAX

Returns

mixed

dropdown_menu()

dropdown_menu(string  $element, string  $trigger, array  $items = array(), string  $parent = '') : mixed

New menu

Parameters

string $element
string $trigger
array $items
string $parent

Returns

mixed

dropdown_menu_js()

dropdown_menu_js(string  $element, string  $trigger, string  $item, string  $additional_attributes = '', string  $parent = '') : mixed

New menu JS

Parameters

string $element
string $trigger
string $item
string $additional_attributes
string $parent

Returns

mixed

default_filter_settings()

default_filter_settings() : mixed

AJAX handler - Get options for the member directory "Admin filtering"

Returns

mixed

get_member_directory_id()

get_member_directory_id(int  $page_id) : array

Get member directory id by page id.

Parameters

int $page_id

Page ID.

Returns

array —

Member directories ID.

get_core_search_fields()

get_core_search_fields(array|null  $qv = null, string|null  $search = null) : array

Get the WordPress core searching fields in wp_users query.

Parameters

array|null $qv

WP_User_Query variables.
string|null $search

Search line value.

Returns

array

timepicker_filters_range()

timepicker_filters_range( $filter) : mixed

Parameters

$filter

Returns

mixed

prepare_search()

prepare_search(string  $search) : string

Prepare the search line. Avoid the using mySQL statement.

Parameters

string $search

Returns

string

build_user_actions_list()

build_user_actions_list(int  $user_id) : array

Parameters

int $user_id

Returns

array