WP File Download Developer Documentation
This documentation will help experienced developers to plug any other service with our plugin. Here are all actions and filters for this plugin, if you need some more, feel free to ask by using this for dedicated forum. Thanks for using our plugin!
wpdf_admin_notices
Action to write import notice
Parameters :
none
Return :
void
In files :
line 35
line 120
wpfd_after_category_main_settings
Action fire after category main settings in right panel
Parameters :
integer Current category id
Return :
void
In files :
line 160
wpfd_after_create_new_category
Action after new category created
Parameters :
integer New category id
string Category created name
Return :
void
In files :
line 77
wpfd_after_fieldset_category_main_settings
Action fire after category main settings fieldset in right panel
Parameters :
integer Current category id
Return :
void
In files :
line 169
wpfd_after_file_main_settings
Action thrown after all file settings inputs have been echoed
Parameters :
string Curent file informations
Return :
void
In files :
line 178
wpfd_after_single_file_info
Action fire after file info in single file display
Parameters :
object File object
Return :
void
In files :
line 55
wpfd_after_template_part
Action fire after a template part called
Parameters :
string Template name
string Template path dir
string Template path
array Template variables
Return :
void
In files :
line 645
wpfd_before_category_main_settings
Action fire before category main settings in right panel
Parameters :
integer Current category id
Return :
void
In files :
line 66
wpfd_before_fieldset_category_main_settings
Action fire before category main settings field set in right panel
Parameters :
integer Current category id
Return :
void
In files :
line 53
wpfd_before_single_file_info
Action fire before file info in single file display
Parameters :
object File object
Return :
void
In files :
line 39
wpfd_before_template_part
Action fire before a template part called
Parameters :
string Template name
string Template path dir
string Template path
array Template variables
Return :
void
In files :
line 633
wpfd_file_deleted
Action fire after a file deleted
Parameters :
array Deleted file info
WP_Term Category the file was deleted from
array Additional information
Return :
void
In files :
line 447
line 506
wpfd_file_download
Action fire right before a file download.
Do not echo anything here or file download will corrupt
Parameters :
object File id
array Source
Return :
void
In files :
line 182
line 243
line 286
line 326
wpfd_file_uploaded
Action fire after file uploaded
Parameters :
integer|WP_Error The file ID on success. The value 0 or WP_Error on failure.
array Additional information
Return :
void
In files :
line 613
wpfd_save_category
Action fire after save category parameters
Parameters :
integer Term id
array Category params
Return :
void
In files :
line 152
wpfd_save_category_settings_button
Action fire before category save button in right panel
Parameters :
integer Current category id
Return :
void
In files :
line 287
wpfd_save_file_params
After file data was saved to database
Parameters :
array File data array
Return :
void
In files :
line 127
wpfd_update_category_name
Update category name
Parameters :
integer Term id to change name
string New category name
Return :
void
In files :
line 113
wpfd_{$themeName}_after_template_hooks
Action fire after template hooked
Parameters :
none
Return :
void
In files :
line 83
line 115
line 470
wpfd_{$themeName}_after_theme_content
Action print after theme content
Parameters :
object Current theme instance
array Category config
Return :
void
In files :
line 239
line 213
line 218
line 234
wpfd_{$themeName}_before_files_loop
Action fire before files loop
Parameters :
object Current theme params
array Category config
Return :
void
In files :
line 151
line 172
line 138
line 136
wpfd_{$themeName}_before_files_loop_handlebars
Action fire before files loop in handlebars template
Parameters :
array Current theme params
array Category config
Return :
void
In files :
line 31
line 95
line 29
wpfd_{$themeName}_before_template_hooks
Action fire before templates hooked
Parameters :
none
Return :
void
In files :
line 382
wpfd_{$themeName}_before_theme_content
Action print before theme content
Parameters :
object Current theme params
Return :
void
In files :
line 137
line 187
line 115
line 136
line 106
line 101
wpfd_{$themeName}_buttons
Action to show buttons
Parameters :
object Current file object
array Global config
array Category config
Return :
void
In files :
line 216
line 197
line 210
wpfd_{$themeName}_buttons_handlebars
Action print buttons in handlebars template
Parameters :
array $config Main config
array $params Category config
Return :
void
In files :
line 73
line 95
line 71
line 87
line 77
wpfd_{$themeName}_columns
Action to show columns
Parameters :
array Main config
array Category config
Return :
void
In files :
line 161
wpfd_{$themeName}_file_block
Action to show file block
Parameters :
object Current file object
array Global config
array Category config
Return :
void
In files :
line 192
wpfd_{$themeName}_file_block_handlebars
Action to show file block in handlebars template
Parameters :
array Main config
array Category config
Return :
void
In files :
line 117
wpfd_{$themeName}_file_content
Action to show file content
Parameters :
object Current file object
array Global config
array Category config
Return :
void
In files :
line 175
line 160
wpfd_{$themeName}_file_content_handlebars
Action print file content in handlebars template
Parameters :
array $config Main config
array $params Category config
Return :
void
In files :
line 33
line 55
line 32
line 51
wpfd_{$themeName}_file_info
Action to show file info
Parameters :
object Current file object
array Category config
Return :
void
In files :
line 196
line 179
line 190
wpfd_{$themeName}_file_info_handlebars
Action to show file info in handlebars template
Parameters :
array Global config
array Category config
Return :
void
In files :
line 55
line 76
line 53
line 70
line 58
wpfd_{$themeName}_folder_tree
Action print folder tree
Parameters :
object Current theme params
array Category config
Return :
void
In files :
line 132
line 153
line 121
line 117
wpfd_before_save_category
Filter for category parameters before save to database
Parameters :
array Category params
integer Term id
Return :
array
In files :
line 142
wpfd_before_save_file_metadata
Filter allow modify file meta data before save to database
Parameters :
array File meta data array
Return :
array
In files :
line 118
wpfd_before_save_file_params
Filter allow modify file data before save to database
Parameters :
array File data array
Return :
array
In files :
line 69
wpfd_before_update_category_name
Filter update category name
Parameters :
string New category name
integer Term id to change name
Return :
string|boolean
In files :
line 105
wpfd_before_upload_file
Filter before upload file
Parameters :
array File data
integer Current user id
Return :
array
In files :
line 566
wpfd_clean_interval
Filter to change clean junks time, this will override WPFD_CLEAN_INTERVAL constance
Parameters :
$interval Time in second
Return :
void
In files :
line 1140
wpfd_default_category_params
Filters allow setup default params for new category
Parameters :
array Default values: order, orderby, roles, private
Return :
array
In files :
line 70
line 58
line 151
line 314
line 469
line 214
wpfd_file_info
Filter file info in front
Parameters :
object File object
Return :
object
In files :
line 235
line 308
line 265
wpfd_file_params
Filter to update data before load to fields
Parameters :
array Data load to fields
Return :
array
In files :
line 99
wpfd_file_title
Filter to change file title
Parameters :
string File title
integer File id
Return :
string
In files :
line 78
line 275
line 188
line 167
line 254
wpfd_get_support_cloud
Filter return supported cloud platform
Require to detect where categories/files from
Parameters :
array Cloud platform list
Return :
array
In files :
line 767
wpfd_get_template
Allow 3rd party plugin filter
Parameters :
string Template path
string Template name
array Template variables
string Template path dir
string Default path dir
Return :
string
In files :
line 623
wpfd_locate_template
Filter on return found template path
Parameters :
string Template path
string Template name
string Template path dir
Return :
void
In files :
line 585
wpfd_locate_theme
Filter on return found template path
Parameters :
string Template path
string Template name
string Template path dir
Return :
void
In files :
line 710
wpfd_preview_service_url
Filter to change preview service url
Parameters :
string Preview url with %s placeholder for url
Return :
string
In files :
line 75
wpfd_preview_url
Filter to change preview url
Parameters :
string Output url
string Preview url with %s placeholder for file encoded url
string Ajax Url to preview file
Return :
string
In files :
line 85
wpfd_search_results
Filters for search results
Parameters :
array Files results
array Search filters
Return :
array
In files :
line 277
wpfd_search_results_file_title_length
Allow to change file length on search results
Parameters :
integer
Return :
void
In files :
line 428
wpfd_token_live_time
Filter to change token live time
Parameters :
int Token live time in seconds
Return :
int
In files :
line 1118
line 120
line 167
wpfd_user_can
Filter check capability of current user to manage file
Parameters :
boolean The current user has the given capability
string Action name
Return :
boolean
In files :
line 802
line 822
line 842
line 862
line 882
line 54
line 100
wpfd_{$themeName}_back_button_handlebars
Filter to change html and arguments of back button handlebars
Parameters :
array Template array
object Current theme object
array Current category config
Return :
array
In files :
line 1535
wpfd_{$themeName}_category_item
Filter to change html and arguments of categories item
Parameters :
array Template array
object Current category object
object Current theme object
array Current category config
Return :
array
In files :
line 1676
wpfd_{$themeName}_category_item_handlebars
Filter to change html and arguments of categories item handlebars
Parameters :
array Template array
object Current theme object
array Current category config
Return :
array
In files :
line 1628
wpfd_{$themeName}_category_title
Filter to change html and arguments of category title
Parameters :
array Template array
object Current theme object
array Current category config
Return :
array
In files :
line 1588
wpfd_{$themeName}_category_title_handlebars
Filter to change html and arguments of category title handlebars
Parameters :
array Template array
object Current theme object
array Current category config
Return :
array
In files :
line 1555
wpfd_{$themeName}_category_tree
Filter to change html and arguments of category tree
Parameters :
array Template array
object Current theme object
array Current category config
Return :
array
In files :
line 1711
wpfd_{$themeName}_column_created_header_html
Filter to change html header of created date column
Parameters :
string Header html
Return :
string
In files :
line 707
wpfd_{$themeName}_column_description_header_html
Filter to change html header of description column
Parameters :
string Header html
Return :
string
In files :
line 611
wpfd_{$themeName}_column_download_header_html
Filter to change html header of download column
Parameters :
string Header html
Return :
string
In files :
line 755
wpfd_{$themeName}_column_hits_header_html
Filter to change html header of hits column
Parameters :
string Header html
Return :
string
In files :
line 683
wpfd_{$themeName}_column_modified_header_html
Filter to change html header of modified date column
Parameters :
string Header html
Return :
string
In files :
line 731
wpfd_{$themeName}_column_size_header_html
Filter to change html header of size column
Parameters :
string Header html
Return :
string
In files :
line 659
wpfd_{$themeName}_column_title_header_html
Filter to change html header of title column
Parameters :
string Header html
Return :
string
In files :
line 587
wpfd_{$themeName}_column_version_header_html
Filter to change html header of version column
Parameters :
string Header html
Return :
string
In files :
line 635
wpfd_{$themeName}_content_wrapper
Filter to change content wrapper output
Parameters :
string Content wrapper
object Current theme object
Return :
string
In files :
line 510
wpfd_{$themeName}_content_wrapper_input
Filters to print hidden input below content wrapper
Parameters :
string Input html
object Current theme object
Return :
string
In files :
line 530
wpfd_{$themeName}_file_download_button_args
Filter to change html and arguments of download button
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 1290
wpfd_{$themeName}_file_download_button_handlebars_args
Filter to change html and arguments of download button handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 1240
wpfd_{$themeName}_file_info_created_args
Filter to change html and arguments of created
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 954
wpfd_{$themeName}_file_info_created_handlebars_args
Filter to change html and arguments of created handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 916
wpfd_{$themeName}_file_info_description_args
Filter to change html and arguments of description
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 651
wpfd_{$themeName}_file_info_description_handlebars_args
Filter to change html and arguments of description handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 612
wpfd_{$themeName}_file_info_hits_args
Filter to change html and arguments of hits
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 880
wpfd_{$themeName}_file_info_hits_handlebars_args
Filter to change html and arguments of hits handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 842
wpfd_{$themeName}_file_info_icon_hanlebars
Filter to change icon html for handlebars template
Parameters :
string Output html for handlebars template
array Main config
array Current category config
Return :
string
In files :
line 1066
line 185
wpfd_{$themeName}_file_info_icon_html
Filter to change icon html
Parameters :
string Output html for handlebars template
object Current file object
array Main config
array Current category config
Return :
string
In files :
line 1109
line 269
wpfd_{$themeName}_file_info_modified_args
Filter to change html and arguments of modified
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 1028
wpfd_{$themeName}_file_info_modified_handlebars_args
Filter to change html and arguments of modified handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 990
wpfd_{$themeName}_file_info_size_args
Filter to change html and arguments of size
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 806
wpfd_{$themeName}_file_info_size_handlebars_args
Filter to change html and arguments of size handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 767
wpfd_{$themeName}_file_info_title_args
Filter to change html and arguments of title
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 1192
line 299
wpfd_{$themeName}_file_info_title_handlebars_args
Filter to change html and arguments of title handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 1149
line 213
wpfd_{$themeName}_file_info_version_args
Filter to change html and arguments of version
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 730
wpfd_{$themeName}_file_info_version_handlebars_args
Filter to change html and arguments of version handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 689
wpfd_{$themeName}_file_open_pdf_button_args
Filter to change html and arguments of open pdf button
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 1425
wpfd_{$themeName}_file_open_pdf_button_handlebars_args
Filter to change html and arguments of open pdf button handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 1338
wpfd_{$themeName}_file_preview_button_args
Filter to change html and arguments of preview button
Parameters :
array Template array
object Current file object
array Main config
array Current category config
Return :
array
In files :
line 1460
wpfd_{$themeName}_file_preview_button_handlebars_args
Filter to change html and arguments of preview button handlebars
Parameters :
array Template array
array Main config
array Current category config
Return :
array
In files :
line 1370
Composer
Here is the solution to use our plugins as a composer dependency.
You have to declare in your composer.json file the joomunited repository, please make sure to replace the YOUR_TOKEN in the url by your own token. You can find it under https://www.joomunited.com/my-account under the Composer token accordion.
{
"repositories":[
{
"type":"package",
"package":{
"name":"joomunited/wp-file-download",
"version":"master",
"type":"wordpress-plugin",
"dist":{
"type":"zip",
"url":"https://www.joomunited.com/extra/download/wp-file-download/YOUR_TOKEN",
"reference":"master"
}
}
}
],
"require":{
"composer/installers":"~1.0",
"joomunited/wp-file-download":"dev-master"
}
}
