BP_Document_Folder::get( array $args = array() )

Get folders, as specified by parameters.

Description

Parameters

$args

(Optional) An array of arguments. All items are optional

Default value: array()

Return

(array) The array returned has two keys: - 'total' is the count of located documents - 'folders' is an array of the located documents

Source

File: bp-document/classes/class-bp-document-folder.php

public static function get( $args = array() ) {
 
    global $wpdb;
 
    $bp = buddypress();
    $r  = wp_parse_args(
        $args,
        array(
            'page'         => 1,               // The current page.
            'per_page'     => 20,              // folders per page.
            'max'          => false,           // Max number of items to return.
            'fields'       => 'all',           // Fields to include.
            'sort'         => 'DESC',          // ASC or DESC.
            'order_by'     => 'date_created',  // Column to order by.
            'exclude'      => false,           // Array of ids to exclude.
            'search_terms' => false,           // Terms to search by.
            'user_id'      => false,           // user id.
            'group_id'     => false,           // group id.
            'privacy'      => false,           // public, loggedin, onlyme, friends, grouponly.
            'count_total'  => false,           // Whether or not to use count_total.
            'in'           => false,           // Array of ids to limit query by (IN).
            'meta_query'   => false,           // Filter by foldermeta.
        )
    );
 
    // Select conditions.
    $select_sql = 'SELECT DISTINCT f.id';
 
    $from_sql = " FROM {$bp->document->table_name_folder} f";
 
    $join_sql = '';
 
    // Where conditions.
    $where_conditions = array();
 
    // Searching.
    if ( $r['search_terms'] ) {
        $search_terms_like              = '%' . bp_esc_like( $r['search_terms'] ) . '%';
        $where_conditions['search_sql'] = $wpdb->prepare( 'f.title LIKE %s', $search_terms_like );
 
        /**
         * Filters whether or not to include users for search parameters.
         *
         * @param bool $value Whether or not to include user search. Default false.
         *
         * @since BuddyBoss 1.4.0
         */
        if ( apply_filters( 'bp_document_folder_get_include_user_search', false ) ) {
            $user_search = get_user_by( 'slug', $r['search_terms'] );
            if ( false !== $user_search ) {
                $user_id                         = $user_search->ID;
                $where_conditions['search_sql'] .= $wpdb->prepare( ' OR f.user_id = %d', $user_id );
            }
        }
    }
 
    // Sorting.
    $sort = $r['sort'];
    if ( 'ASC' !== $sort && 'DESC' !== $sort ) {
        $sort = 'DESC';
    }
 
    switch ( $r['order_by'] ) {
        case 'id':
        case 'user_id':
        case 'group_id':
        case 'title':
            break;
 
        default:
            $r['order_by'] = 'date_created';
            break;
    }
    $order_by = 'f.' . $r['order_by'];
 
    // Exclude specified items.
    if ( ! empty( $r['exclude'] ) ) {
        $exclude                     = implode( ',', wp_parse_id_list( $r['exclude'] ) );
        $where_conditions['exclude'] = "f.id NOT IN ({$exclude})";
    }
 
    // The specific ids to which you want to limit the query.
    if ( ! empty( $r['in'] ) ) {
        $in                     = implode( ',', wp_parse_id_list( $r['in'] ) );
        $where_conditions['in'] = "f.id IN ({$in})";
    }
 
    if ( ! empty( $r['user_id'] ) ) {
        $where_conditions['user'] = "f.user_id = {$r['user_id']}";
    }
 
    if ( ! empty( $r['group_id'] ) ) {
        $where_conditions['user'] = "f.group_id = {$r['group_id']}";
    }
 
    if ( ! empty( $r['privacy'] ) ) {
        $privacy                     = "'" . implode( "', '", $r['privacy'] ) . "'";
        $where_conditions['privacy'] = "f.privacy IN ({$privacy})";
    }
 
    // Process meta_query into SQL.
    $meta_query_sql = self::get_meta_query_sql( $r['meta_query'] );
 
    if ( ! empty( $meta_query_sql['join'] ) ) {
        $join_sql .= $meta_query_sql['join'];
    }
 
    /**
     * Filters the MySQL WHERE conditions for the folders get method.
     *
     * @param array  $where_conditions Current conditions for MySQL WHERE statement.
     * @param array  $r                Parsed arguments passed into method.
     * @param string $select_sql       Current SELECT MySQL statement at point of execution.
     * @param string $from_sql         Current FROM MySQL statement at point of execution.
     * @param string $join_sql         Current INNER JOIN MySQL statement at point of execution.
     *
     * @since BuddyBoss 1.4.0
     */
    $where_conditions = apply_filters( 'bp_document_folder_get_where_conditions', $where_conditions, $r, $select_sql, $from_sql, $join_sql );
 
    if ( empty( $where_conditions ) ) {
        $where_conditions['2'] = '2';
    }
 
    // Join the where conditions together.
    $where_sql = 'WHERE ' . join( ' AND ', $where_conditions );
 
    /**
     * Filter the MySQL JOIN clause for the main document query.
     *
     * @param string $join_sql   JOIN clause.
     * @param array  $r          Method parameters.
     * @param string $select_sql Current SELECT MySQL statement.
     * @param string $from_sql   Current FROM MySQL statement.
     * @param string $where_sql  Current WHERE MySQL statement.
     *
     * @since BuddyBoss 1.4.0
     */
    $join_sql = apply_filters( 'bp_document_folder_get_join_sql', $join_sql, $r, $select_sql, $from_sql, $where_sql );
 
    // Sanitize page and per_page parameters.
    $page     = absint( $r['page'] );
    $per_page = absint( $r['per_page'] );
 
    $retval = array(
        'folders'        => null,
        'total'          => null,
        'has_more_items' => null,
    );
 
    // Query first for folder IDs.
    $folder_ids_sql = "{$select_sql} {$from_sql} {$join_sql} {$where_sql} ORDER BY {$order_by} {$sort}, f.id {$sort}";
 
    if ( ! empty( $per_page ) && ! empty( $page ) ) {
        // We query for $per_page + 1 items in order to
        // populate the has_more_items flag.
        $folder_ids_sql .= $wpdb->prepare( ' LIMIT %d, %d', absint( ( $page - 1 ) * $per_page ), $per_page + 1 );
    }
 
    /**
     * Filters the paged document MySQL statement.
     *
     * @param string $folder_ids_sql MySQL statement used to query for Document IDs.
     * @param array  $r              Array of arguments passed into method.
     *
     * @since BuddyBoss 1.4.0
     */
    $folder_ids_sql = apply_filters( 'bp_document_folder_paged_activities_sql', $folder_ids_sql, $r );
 
    $cache_group = 'bp_document_folder';
 
    $cached = bp_core_get_incremented_cache( $folder_ids_sql, $cache_group );
    if ( false === $cached ) {
        $folder_ids = $wpdb->get_col( $folder_ids_sql ); // db call ok; no-cache ok;
        bp_core_set_incremented_cache( $folder_ids_sql, $cache_group, $folder_ids );
    } else {
        $folder_ids = $cached;
    }
 
    $retval['has_more_items'] = ! empty( $per_page ) && count( $folder_ids ) > $per_page;
 
    // If we've fetched more than the $per_page value, we
    // can discard the extra now.
    if ( ! empty( $per_page ) && count( $folder_ids ) === $per_page + 1 ) {
        array_pop( $folder_ids );
    }
 
    if ( 'ids' === $r['fields'] ) {
        $folders = array_map( 'intval', $folder_ids );
    } else {
        $folders = self::get_folder_data( $folder_ids );
    }
 
    if ( 'ids' !== $r['fields'] ) {
        // Get the fullnames of users so we don't have to query in the loop.
        // $albums = self::append_user_fullnames( $albums );
 
        // Pre-fetch data associated with document users and other objects.
        $folders = self::prefetch_object_data( $folders );
    }
 
    $retval['folders'] = $folders;
 
    // If $max is set, only return up to the max results.
    if ( ! empty( $r['count_total'] ) ) {
 
        /**
         * Filters the total document MySQL statement.
         *
         * @param string $value     MySQL statement used to query for total documents.
         * @param string $where_sql MySQL WHERE statement portion.
         * @param string $sort      Sort direction for query.
         *
         * @since BuddyBoss 1.4.0
         */
        $total_folders_sql = apply_filters( 'bp_document_folder_total_documents_sql', "SELECT count(DISTINCT f.id) FROM {$bp->document->table_name_folder} f {$join_sql} {$where_sql}", $where_sql, $sort );
        $cached            = bp_core_get_incremented_cache( $total_folders_sql, $cache_group );
        if ( false === $cached ) {
            $total_folders = $wpdb->get_var( $total_folders_sql ); // db call ok; no-cache ok;
            bp_core_set_incremented_cache( $total_folders_sql, $cache_group, $total_folders );
        } else {
            $total_folders = $cached;
        }
 
        if ( ! empty( $r['max'] ) ) {
            if ( (int) $total_folders > (int) $r['max'] ) {
                $total_folders = $r['max'];
            }
        }
 
        $retval['total'] = $total_folders;
    }
 
    return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyBoss 1.4.0	Introduced.

Uses

Uses
Uses	Description
bp-document/classes/class-bp-document-folder.php: BP_Document_Folder::get_meta_query_sql()	Get the SQL for the ‘meta_query’ param in BP_Document::get().
bp-document/classes/class-bp-document-folder.php: BP_Document_Folder::get_folder_data()	Convert document IDs to document objects, as expected in template loop.
bp-document/classes/class-bp-document-folder.php: BP_Document_Folder::prefetch_object_data()	Pre-fetch data for objects associated with folders.
bp-document/classes/class-bp-document-folder.php: bp_document_folder_get_include_user_search	Filters whether or not to include users for search parameters.
bp-document/classes/class-bp-document-folder.php: bp_document_folder_get_where_conditions	Filters the MySQL WHERE conditions for the folders get method.
bp-document/classes/class-bp-document-folder.php: bp_document_folder_get_join_sql	Filter the MySQL JOIN clause for the main document query.
bp-document/classes/class-bp-document-folder.php: bp_document_folder_paged_activities_sql	Filters the paged document MySQL statement.
bp-document/classes/class-bp-document-folder.php: bp_document_folder_total_documents_sql	Filters the total document MySQL statement.
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-core/bp-core-functions.php: bp_esc_like()	Escape special characters in a SQL LIKE clause.
bp-core/bp-core-cache.php: bp_core_get_incremented_cache()	Gets a value that has been cached using an incremented key.
bp-core/bp-core-cache.php: bp_core_set_incremented_cache()	Caches a value using an incremented key.

Show 7 more uses Hide more uses

Used By
Used By	Description
bp-document/classes/class-bp-document-folder.php: BP_Document_Folder::folder_exists()	Get whether an folder exists for a given id.
bp-document/bp-document-functions.php: bp_folder_get()	Retrieve an folder or folders.
bp-document/bp-document-functions.php: bp_folder_get_specific()	Fetch specific folders.

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.

Contents