API Documentation
Back to top  

PDA_Private_Link_Services

Service class that containing the helper functions in order to interact with the private links.

Class PDA_Private_Link_Services

package

pda_services

Methods

Create new private link for the protected attachment file.

create_private_link(integer $attachment_id, array $data,  $use_raw_url = true) : string
static

Code example: https://gist.github.com/bwps/577a06d2f1f6a063a2e856da167fdc18

Arguments

$attachment_id

integer

The attachment's id.

$data

array

(optional) Array structure to define additional information for the private links.

$data = [

'expired_days' => (integer) The number of days the private link will expire from the created day.

'limit_downloads' => (integer) The max number of times that link can be downloaded.

]

Example:

$data = [

'expired_days' => 5,

'limit_downloads' => 3,

]

Happy coding.

$use_raw_url

Response

string

Return empty string if the attachment file is not protected, otherwise return the new private link.

Set permission for file is protected

pda_set_permission_for_file_protect(integer $attachment_id, array $fap = array()) : boolean
static

Arguments

$attachment_id

integer

The attachment's id.

$fap

array

Permission.

Response

boolean

Protect attachment file

protect_file(integer $attachment_id) : boolean|\WP_Error
static

Code example: https://gist.github.com/bwps/9fee59a084f2c1cccba45a97ac335d0c

Arguments

$attachment_id

integer

The attachment's id.

Response

boolean|\WP_Error