Ultimate Member - PHPDoc
\
um
admin
core
ajax
common
core
rest
frontend
lib
mobiledetect
widgets

\um\coreUploader

Class Uploader

Summary

Methods
Properties
Constants
__construct()
init()
get_core_temp_dir()
get_core_temp_url()
get_core_upload_dir()
get_upload_base_url()
get_upload_base_dir()
get_upload_user_base_dir()
get_upload_user_base_url()
validate_upload()
set_upload_directory()
upload_image()
upload_file()
validate_image_data()
validate_file_data()
unique_filename()
delete_existing_file()
profile_photo()
cover_photo()
stream_photo()
resize_image()
rotate_uploaded_image()
move_temporary_files()
remove_unused_uploads()
$user_id
$replace_upload_dir
$field_key
$wp_upload_dir
$temp_upload_dir
$core_upload_dir
$core_upload_url
$upload_baseurl
$upload_basedir
$upload_user_baseurl
$upload_user_basedir
$upload_image_type
$upload_type
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$user_id

$user_id : int

Type

normal

$replace_upload_dir

$replace_upload_dir : int

Type

normal

$field_key

$field_key : string

Type

normal

$wp_upload_dir

$wp_upload_dir : string

Type

normal

$temp_upload_dir

$temp_upload_dir : string

Type

normal

$core_upload_dir

$core_upload_dir : string

Type

normal

$core_upload_url

$core_upload_url : string

Type

normal

$upload_baseurl

$upload_baseurl : string

Type

normal

$upload_basedir

$upload_basedir : string

Type

normal

$upload_user_baseurl

$upload_user_baseurl : string

Type

normal

$upload_user_basedir

$upload_user_basedir : string

Type

normal

$upload_image_type

$upload_image_type : string

Type

normal

$upload_type

$upload_type : string

Type

normal

Methods

__construct()

__construct() : mixed

Uploader constructor.

Returns

mixed

init()

init() : mixed

Init

Returns

mixed

get_core_temp_dir()

get_core_temp_dir() : string

Get core temporary directory path

Returns

string

get_core_temp_url()

get_core_temp_url() : string

Get core temporary directory URL

Returns

string

get_core_upload_dir()

get_core_upload_dir() : string

Get core upload directory

Returns

string

get_upload_base_url()

get_upload_base_url() : string

Get core upload base url

Returns

string

get_upload_base_dir()

get_upload_base_dir() : string

Get core upload base directory

Returns

string

get_upload_user_base_dir()

get_upload_user_base_dir(int  $user_id = null, bool  $create_dir = false) : string

Get user upload base directory

Parameters

int $user_id
bool $create_dir

Returns

string

get_upload_user_base_url()

get_upload_user_base_url(int  $user_id = null) : string

Get user upload base url

Parameters

int $user_id

Returns

string

validate_upload()

validate_upload(array  $file) : array

Validate file size

Parameters

array $file

Returns

array

set_upload_directory()

set_upload_directory(array  $args) : array

Set upload directory

Parameters

array $args

Returns

array

upload_image()

upload_image(array  $uploadedfile, int|null  $user_id = null, string  $field_key = '', string  $upload_type = 'stream_photo') : array

Upload Image files

Parameters

array $uploadedfile
int|null $user_id
string $field_key
string $upload_type

Throws

\Exception

Returns

array

upload_file()

upload_file( $uploadedfile, int|null  $user_id = null, string  $field_key = '') : array

Upload Files

Parameters

$uploadedfile
int|null $user_id
string $field_key

Returns

array

validate_image_data()

validate_image_data( $file, mixed  $field_key) : null|string

Check image upload and handle errors

Parameters

$file
mixed $field_key

Returns

null|string

validate_file_data()

validate_file_data( $file, mixed  $field_key) : null|string

Check file upload and handle errors

Parameters

$file
mixed $field_key

Returns

null|string

unique_filename()

unique_filename(string  $dir, string  $filename, string  $ext) : string

Make unique filename

Parameters

string $dir
string $filename
string $ext

Returns

string —

$filename

delete_existing_file()

delete_existing_file(string  $filename, string  $ext = '', string  $dir = '') : mixed

Delete file

Parameters

string $filename
string $ext
string $dir

Returns

mixed

profile_photo()

profile_photo(array  $response, string  $image_path, string  $src, string  $key, int  $user_id, string  $coord, array  $crop) : array

Profile photo image process

Parameters

array $response
string $image_path
string $src
string $key
int $user_id
string $coord
array $crop

Returns

array

cover_photo()

cover_photo(array  $response, mixed  $image_path, string  $src, mixed  $key, int  $user_id, string  $coord, array  $crop) : array

Cover photo image process

Parameters

array $response
mixed $image_path
string $src
mixed $key
int $user_id
string $coord
array $crop

Returns

array

stream_photo()

stream_photo(array  $response, string  $image_path, string  $src, mixed  $key, int  $user_id, string  $coord = '', array  $crop = array()) : array

Stream photo image process

Parameters

array $response
string $image_path
string $src
mixed $key
int $user_id
string $coord
array $crop

Returns

array

resize_image()

resize_image(string  $image_path, string  $src, string  $key, int  $user_id, string  $coord) : array

Resize Image

Parameters

string $image_path
string $src
string $key
int $user_id
string $coord

Returns

array

rotate_uploaded_image()

rotate_uploaded_image(array  $movefile) : array

Fix image orientation

Parameters

array $movefile

Returns

array

move_temporary_files()

move_temporary_files( $user_id,  $files, bool  $move_only = false) : mixed

Move temporary files

run when uploaded files are from custom fields move them to the users' folder after form submitted

Parameters

$user_id
$files
bool $move_only

Returns

mixed

remove_unused_uploads()

remove_unused_uploads(int  $user_id, array  $new_files, array  $old_files = array()) : mixed

Clean user temp uploads

Parameters

int $user_id
array $new_files
array $old_files

Returns

mixed