Contents

Code Reference Functions document_screen_single_folder()

document_screen_single_folder()

Load an individual folder screen.

Description

Return

(false|null) False on failure.

Source

File: bp-document/screens/folders.php

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
function document_screen_single_folder() {
 
    // Bail if not viewing a single folder.
    if ( ! bp_is_document_component() || ! bp_is_single_folder() ) {
        return false;
    }
 
    $folder_id = (int) bp_action_variable( 0 );
 
    if ( empty( $folder_id ) || ! BP_Document_Folder::folder_exists( $folder_id ) ) {
        if ( is_user_logged_in() ) {
            bp_core_add_message( __( 'The folder you tried to access is no longer available', 'buddyboss' ), 'error' );
        }
 
        bp_core_redirect( trailingslashit( bp_displayed_user_domain() . bp_get_document_slug() . '/folders' ) );
    }
 
    // No access.
    if ( ( ! folders_check_folder_access( $folder_id ) && ! bp_is_my_profile() ) && ! bp_current_user_can( 'bp_moderate' ) ) {
        bp_core_add_message( __( 'You do not have access to that folder.', 'buddyboss' ), 'error' );
        bp_core_redirect( trailingslashit( bp_displayed_user_domain() . bp_get_document_slug() ) );
    }
 
    /**
     * Fires right before the loading of the single folder view screen template file.
     *
     * @since BuddyBoss 1.4.0
     */
    do_action( 'document_screen_single_folder' );
 
    /**
     * Filters the template to load for the Single Folder view screen.
     *
     * @since BuddyBoss 1.4.0
     *
     * @param string $template Path to the folder template to load.
     */
    bp_core_load_template( apply_filters( 'document_template_single_folder', 'members/single/home' ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.4.0 Introduced.

Uses

Uses
Uses Description
bp-document/screens/folders.php: document_screen_single_folder

Fires right before the loading of the single folder view screen template file.
bp-document/screens/folders.php: document_template_single_folder

Filters the template to load for the Single Folder view screen.
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-template.php: bp_get_document_slug()

Return the document component slug.
bp-document/bp-document-functions.php: folders_check_folder_access()

Check folder access for current user or guest
bp-core/bp-core-template.php: bp_is_single_folder()

Is the current page a single folder item permalink?
bp-core/bp-core-template.php: bp_is_document_component()

Check whether the current page is part of the Document component.
bp-members/bp-members-template.php: bp_displayed_user_domain()

Generate the link for the displayed user’s profile.
bp-core/bp-core-template.php: bp_is_my_profile()

Is the current page part of the profile of the logged-in user?
bp-core/bp-core-template.php: bp_action_variable()

Return the value of a given action variable.
bp-core/bp-core-caps.php: bp_current_user_can()

Check whether the current user has a given capability.
bp-core/bp-core-functions.php: bp_core_add_message()

Add a feedback (error/success) message to the WP cookie so it can be displayed after the page reloads.
bp-core/bp-core-functions.php: bp_core_redirect()

Perform a status-safe wp_redirect() that is compatible with BP’s URI parser.
bp-core/bp-core-catchuri.php: bp_core_load_template()

Load a specific template file with fallback support.
Show 9 more uses Hide more uses

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.