bp_album_get_specific( array|string $args = '' )
Fetch specific albums.
Description
See also
- BP_Media_Album::get(): For more information on accepted arguments.
Parameters
- $args
-
(Optional) All arguments and defaults are shared with BP_Media_Album::get(), except for the following:
- 'Single'
(string|int|array) album ID, comma-separated list of IDs, or array of IDs.
Default value: ''
- 'Single'
Return
(array) $albums See BP_Media_Album::get() for description.
Source
File: bp-media/bp-media-functions.php
function bp_album_get_specific( $args = '' ) { $r = bp_parse_args( $args, array( 'album_ids' => false, // A single album id or array of IDs. 'max' => false, // Maximum number of results to return. 'page' => 1, // Page 1 without a per_page will result in no pagination. 'per_page' => false, // Results per page. 'sort' => 'DESC', // Sort ASC or DESC 'update_meta_cache' => true, ), 'media_get_specific' ); $get_args = array( 'in' => $r['album_ids'], 'max' => $r['max'], 'page' => $r['page'], 'per_page' => $r['per_page'], 'sort' => $r['sort'], ); /** * Filters the requested specific album item. * * @since BuddyBoss * * @param BP_Media $album Requested media object. * @param array $args Original passed in arguments. * @param array $get_args Constructed arguments used with request. */ return apply_filters( 'bp_album_get_specific', BP_Media_Album::get( $get_args ), $args, $get_args ); }
Changelog
Version | Description |
---|---|
BuddyBoss 1.0.0 | Introduced. |
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.