Contents

Code Reference Classes BP_Media_Template BP_Media_Template::__construct()

BP_Media_Template::__construct( array $args )

Constructor method.

Description

The arguments passed to this class constructor are of the same format as BP_Media::get().

See also

  • BP_Media::get(): for a description of the argument structure, as well as default values.

Parameters

$args

(Required) Array of arguments. Supports all arguments from BP_Media::get(), as well as 'page_arg' and 'include'. Default values for 'per_page' differ from the originating function, and are described below.

  • 'page_arg'
    (string) The string used as a query parameter in pagination links. Default: 'acpage'.
  • 'include'
    (array|bool) Pass an array of media IDs to retrieve only those items, or false to noop the 'include' parameter. 'include' differs from 'in' in that 'in' forms an IN clause that works in conjunction with other filters passed to the function, while 'include' is interpreted as an exact list of items to retrieve, which skips all other filter-related parameters. Default: false.
  • 'per_page'
    (int|bool) Default: 20.

Source

File: bp-media/classes/class-bp-media-template.php

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
public function __construct( $args ) {
 
    $defaults = array(
        'page'              => 1,
        'per_page'          => 20,
        'page_arg'          => 'acpage',
        'max'               => false,
        'fields'            => 'all',
        'count_total'       => false,
        'sort'              => false,
        'order_by'          => false,
        'include'           => false,
        'exclude'           => false,
        'search_terms'      => false,
        'user_id'           => false,
        'album_id'          => false,
        'group_id'          => false,
        'privacy'           => false,
    );
    $r = wp_parse_args( $args, $defaults );
    extract( $r );
 
    $this->pag_arg  = sanitize_key( $r['page_arg'] );
    $this->pag_page = bp_sanitize_pagination_arg( $this->pag_arg, $r['page']     );
    $this->pag_num  = bp_sanitize_pagination_arg( 'num',          $r['per_page'] );
 
    // Get an array of the logged in user's favorite media.
    $this->my_favs = bp_get_user_meta( bp_loggedin_user_id(), 'bp_favorite_media', true );
 
    // Fetch specific media items based on ID's.
    if ( !empty( $include ) ) {
        $this->medias = bp_media_get_specific( array(
            'media_ids'         => explode( ',', $include ),
            'max'               => $max,
            'count_total'       => $count_total,
            'page'              => $this->pag_page,
            'per_page'          => $this->pag_num,
            'sort'              => $sort,
            'order_by'          => $order_by,
            'user_id'           => $user_id,
            'album_id'          => $album_id,
        ) );
 
        // Fetch all activity items.
    } else {
        $this->medias = bp_media_get( array(
            'max'               => $max,
            'count_total'       => $count_total,
            'per_page'          => $this->pag_num,
            'page'              => $this->pag_page,
            'sort'              => $sort,
            'order_by'          => $order_by,
            'search_terms'      => $search_terms,
            'user_id'           => $user_id,
            'album_id'          => $album_id,
            'group_id'          => $group_id,
            'exclude'           => $exclude,
            'privacy'           => $privacy,
        ) );
    }
 
    // The total_media_count property will be set only if a
    // 'count_total' query has taken place.
    if ( ! is_null( $this->medias['total'] ) ) {
        if ( ! $max || $max >= (int) $this->medias['total'] ) {
            $this->total_media_count = (int) $this->medias['total'];
        } else {
            $this->total_media_count = (int) $max;
        }
    }
 
    $this->has_more_items = $this->medias['has_more_items'];
 
    $this->medias = $this->medias['medias'];
 
    if ( $max ) {
        if ( $max >= count($this->medias) ) {
            $this->media_count = count( $this->medias );
        } else {
            $this->media_count = (int) $max;
        }
    } else {
        $this->media_count = count( $this->medias );
    }
 
    if ( (int) $this->total_media_count && (int) $this->pag_num ) {
        $this->pag_links = paginate_links( array(
            'base'      => add_query_arg( $this->pag_arg, '%#%' ),
            'format'    => '',
            'total'     => ceil( (int) $this->total_media_count / (int) $this->pag_num ),
            'current'   => (int) $this->pag_page,
            'prev_text' => __( '←', 'buddyboss' ),
            'next_text' => __( '→', 'buddyboss' ),
            'mid_size'  => 1,
            'add_args'  => array(),
        ) );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.0.0 Introduced.

Uses

Uses
Uses Description
bp-media/bp-media-functions.php: bp_media_get_specific()

Fetch specific media items.
bp-media/bp-media-functions.php: bp_media_get()

Retrieve an media or medias.
bp-core/bp-core-template.php: bp_loggedin_user_id()

Get the ID of the currently logged-in user.
bp-core/bp-core-functions.php: bp_get_user_meta()

Get a piece of usermeta.
bp-core/bp-core-functions.php: bp_sanitize_pagination_arg()

Sanitizes a pagination argument based on both the request override and the original value submitted via a query argument, likely to a template class responsible for limiting the resultset of a template loop.
Used By
Used By Description
bp-media/bp-media-template.php: bp_has_media()

Initialize the media loop.

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.