API Documentation
Back to top  

Disciple_Tools_Groups_Endpoints

Class Disciple_Tools_Groups_Endpoints Custom endpoints file

package

Disciple_Tools\Posts\Groups
category

Plugin
author

Chasm.Solutions & Kingdom.Training
since 0.1.0

Methods

Disciple_Tools_Groups_Endpoints constructor.

__construct()

add_api_routes

add_api_routes()

add_related_info_to_groups

add_related_info_to_groups(array $groups) : array

Arguments

$groups

array

Response

array

add_shared

add_shared(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

create_group

create_group(\WP_REST_Request $request) : array|integer|\WP_Error

Arguments

$request

\WP_REST_Request

Response

array|integer|\WP_Error

delete_comment

delete_comment(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

get_activity

get_activity(\WP_REST_Request $request) : array|null|object|\WP_Error

Arguments

$request

\WP_REST_Request

Response

array|null|object|\WP_Error

get_comments

get_comments(\WP_REST_Request $request) : array|integer|\WP_Error

Arguments

$request

\WP_REST_Request

Response

array|integer|\WP_Error

get_following

get_following(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

Get a single group by ID

get_group(\WP_REST_Request $request) : array|\WP_Error
access

public
since 0.1.0

Arguments

$request

\WP_REST_Request

Response

array|\WP_Error

The group on success

get_group_default_filter_counts

get_group_default_filter_counts(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

get_groups_compact

get_groups_compact(\WP_REST_Request $request) : array|\WP_Query

Arguments

$request

\WP_REST_Request

Response

array|\WP_Query

get_settings

get_settings()

get_viewable_groups

get_viewable_groups(\WP_REST_Request $request) : array|\WP_Query

Arguments

$request

\WP_REST_Request

Response

array|\WP_Query

instance

instance() : \Disciple_Tools_Groups_Endpoints|null
static

Response

\Disciple_Tools_Groups_Endpoints|null

post_comment

post_comment(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

remove_shared

remove_shared(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

search_viewable_groups

search_viewable_groups(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

shared_with

shared_with(\WP_REST_Request $request) : array|mixed|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

array|mixed|\WP_Error|\WP_REST_Response

update_comment

update_comment(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

update_group

update_group(\WP_REST_Request $request) : integer|\WP_Error

Arguments

$request

\WP_REST_Request

Response

integer|\WP_Error

Properties

_instance

_instance :
static

Type(s)

version

version :

Type(s)

context

context :

Type(s)

namespace

namespace :

Type(s)

namespace_v2

namespace_v2 :

Type(s)