Contents

Code Reference Functions bp_document_download_file_force()

bp_document_download_file_force( string $file_path, string $filename )

Force download – this is the default method.

Description

Parameters

$file_path

(Required) File path.

$filename

(Required) File name.

Source

File: bp-document/bp-document-filters.php

1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
function bp_document_download_file_force( $file_path, $filename ) {
    $parsed_file_path  = bp_document_parse_file_path( $file_path );
    $download_range   = bp_document_get_download_range( @filesize( $parsed_file_path['file_path'] ) ); // @codingStandardsIgnoreLine.
 
    bp_document_download_headers( $parsed_file_path['file_path'], $filename, $download_range );
 
    $start  = isset( $download_range['start'] ) ? $download_range['start'] : 0;
    $length = isset( $download_range['length'] ) ? $download_range['length'] : 0;
    if ( ! bp_document_readfile_chunked( $parsed_file_path['file_path'], $start, $length ) ) {
        if ( $parsed_file_path['remote_file'] ) {
            bp_document_download_file_redirect( $file_path );
        } else {
            bp_document_download_error( __( 'File not found', 'buddyboss' ) );
        }
    }
 
    exit;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.4.1 Introduced.

Uses

Uses
Uses Description
bp-document/bp-document-filters.php: bp_document_readfile_chunked()

Read file chunked.
bp-document/bp-document-filters.php: bp_document_parse_file_path()

Parse file path and see if its remote or local.
bp-document/bp-document-filters.php: bp_document_get_download_range()

Parse the HTTP_RANGE request from iOS devices.
bp-document/bp-document-filters.php: bp_document_download_headers()

Set headers for the download.
bp-document/bp-document-filters.php: bp_document_download_file_redirect()

Redirect to a file to start the download.
bp-document/bp-document-filters.php: bp_document_download_error()

Die with an error message if the download fails.
Show 1 more use 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.