Users extends Base_Route implements Route

Registers a "users" api route.

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Interfaces, Classes and Traits

Route

Table of Contents

$rest_base  : mixed
get_users()  : WP_REST_Response
Retrieve users from the database.
permission_callback()  : bool
Determine if route can be accessed.
register_routes()  : void
Register routes.
parse_results()  : array<string|int, mixed>
Helper function to parse results for usage in the react app.

Properties

$rest_base

protected mixed $rest_base = 'users'

Methods

get_users()

Retrieve users from the database.

public get_users(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

permission_callback()

Determine if route can be accessed.

public permission_callback() : bool
Return values
bool

register_routes()

Register routes.

public register_routes() : void
Return values
void

parse_results()

Helper function to parse results for usage in the react app.

private parse_results([array<string|int, mixed> $results = [] ]) : array<string|int, mixed>
Parameters
$results : array<string|int, mixed> = []
Return values
array<string|int, mixed>

Search results