Contents

Code Reference Classes BP_REST_Media_Details_Endpoint

BP_REST_Media_Details_Endpoint

BuddyPress Media Details endpoints.

Description

Source

File: bp-media/classes/class-bp-rest-media-details-endpoint.php

16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
class BP_REST_Media_Details_Endpoint extends WP_REST_Controller {
 
    /**
     * BP_REST_Media_Endpoint Instance.
     *
     * @var BP_REST_Media_Endpoint
     */
    protected $media_endpoint;
 
    /**
     * Constructor.
     *
     * @since 0.1.0
     */
    public function __construct() {
        $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
        $this->rest_base = 'media';
 
        $this->media_endpoint = new BP_REST_Media_Endpoint();
    }
 
    /**
     * Register the component routes.
     *
     * @since 0.1.0
     */
    public function register_routes() {
        register_rest_route(
            $this->namespace,
            '/' . $this->rest_base . '/details',
            array(
                array(
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => array( $this, 'get_items' ),
                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
                ),
                'schema' => array( $this, 'get_item_schema' ),
            )
        );
    }
 
 
    /**
     * Retrieve Media details.
     *
     * @param WP_REST_Request $request Full details about the request.
     *
     * @return WP_REST_Response | WP_Error
     * @since 0.1.0
     *
     * @api            {GET} /wp-json/buddyboss/v1/media/details Media Details
     * @apiName        GetBBMediaDetails
     * @apiGroup       Media
     * @apiDescription Retrieve Media details(includes tabs and privacy options)
     * @apiVersion     1.0.0
     * @apiPermission  LoggedInUser if the site is in Private Network.
     */
    public function get_items( $request ) {
        $retval = array();
 
        $retval['tabs']    = $this->get_media_tabs();
        $retval['privacy'] = $this->get_media_privacy();
 
        $response = rest_ensure_response( $retval );
 
        /**
         * Fires after a list of medias details is fetched via the REST API.
         *
         * @since 0.1.0
         *
         * @param WP_REST_Response $response  The response data.
         * @param WP_REST_Request  $request   The request sent to the API.
         */
        do_action( 'bp_rest_media_details_get_items', $response, $request );
 
        return $response;
    }
 
    /**
     * Checks if a given request has access to get all users.
     *
     * @param WP_REST_Request $request Full details about the request.
     *
     * @return bool
     * @since 0.1.0
     */
    public function get_items_permissions_check( $request ) {
        $retval = true;
 
        /**
         * Filter the media details `get_items` permissions check.
         *
         * @param bool            $retval  Returned value.
         * @param WP_REST_Request $request The request sent to the API.
         *
         * @since 0.1.0
         */
        return apply_filters( 'bp_rest_media_details_get_items_permissions_check', $retval, $request );
    }
 
    /**
     * Get the media details schema, conforming to JSON Schema.
     *
     * @return array
     * @since 0.1.0
     */
    public function get_item_schema() {
        $schema = array(
            '$schema'    => 'http://json-schema.org/draft-04/schema#',
            'title'      => 'bp_media_details',
            'type'       => 'object',
            'properties' => array(
                'tabs'    => array(
                    'context'     => array( 'embed', 'view' ),
                    'description' => __( 'Media directory tabs.', 'buddyboss' ),
                    'type'        => 'object',
                    'readonly'    => true,
                    'items'       => array(
                        'type' => 'array',
                    ),
                ),
                'privacy' => array(
                    'context'     => array( 'embed', 'view' ),
                    'description' => __( 'Media privacy.', 'buddyboss' ),
                    'type'        => 'object',
                    'readonly'    => true,
                ),
            ),
        );
 
        /**
         * Filters the media details schema.
         *
         * @param array $schema The endpoint schema.
         */
        return apply_filters( 'bp_rest_media_details_schema', $this->add_additional_fields_schema( $schema ) );
    }
 
    /**
     * Get Media Directory tabs.
     *
     * @since 0.1.0
     *
     * @return array
     */
    public function get_media_tabs() {
        $tabs = array();
 
        add_filter( 'bp_get_total_media_count', array( $this, 'bp_rest_get_total_media_count' ) );
        $tabs_items = function_exists( 'bp_nouveau_get_media_directory_nav_items' ) ? bp_nouveau_get_media_directory_nav_items() : array();
        remove_filter( 'bp_get_total_media_count', array( $this, 'bp_rest_get_total_media_count' ) );
 
        if ( ! empty( $tabs_items ) ) {
            foreach ( $tabs_items as $key => $item ) {
                $tabs[ $key ]['title']    = $item['text'];
                $tabs[ $key ]['count']    = $item['count'];
                $tabs[ $key ]['position'] = $item['position'];
            }
        }
 
        return $tabs;
    }
 
    /**
     * Get privacy for the media.
     *
     * @since 0.1.0
     *
     * @return array
     */
    public function get_media_privacy() {
        $privacy = buddypress()->media->visibility_levels;
        $retval  = array();
 
        if ( ! empty( $privacy ) ) {
            foreach ( $privacy as $key => $value ) {
                if ( 'grouponly' === $key ) {
                    continue;
                }
 
                $retval[ $key ] = $value;
            }
        }
 
        return $retval;
    }
 
    /**
     * Return the total media count in your BP instance.
     *
     * @since 0.1.0
     *
     * @return int Media count.
     */
    public function bp_rest_get_total_media_count() {
        add_filter( 'bp_ajax_querystring', array( $this, 'bp_rest_media_object_results_media_all_scope' ), 20 );
        bp_has_media( bp_ajax_querystring( 'media' ) );
        remove_filter( 'bp_ajax_querystring', array( $this, 'bp_rest_media_object_results_media_all_scope' ), 20 );
        $count = $GLOBALS['media_template']->total_media_count;
 
        /**
         * Filters the total number of media.
         *
         * @since 0.1.0
         *
         * @param int $count Total number of media.
         */
        return apply_filters( 'bp_rest_get_total_media_count', (int) $count );
    }
 
    /**
     * Media results all scope.
     * - from bp_media_object_results_media_all_scope().
     *
     * @since 0.1.0
     *
     * @param array $querystring Query String parameters.
     *
     * @return string
     *
     */
    public function bp_rest_media_object_results_media_all_scope( $querystring ) {
        $querystring = wp_parse_args( $querystring );
 
        $querystring['scope'] = $this->media_endpoint->bp_rest_media_default_scope( 'all', array() );
 
        $querystring['page']        = 1;
        $querystring['per_page']    = 1;
        $querystring['user_id']     = 0;
        $querystring['count_total'] = true;
 
        return http_build_query( $querystring );
    }
 
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Methods

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.