WP Media Folder 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!
Helper file
WP Media Folder comes with a helper file with the main functions you may need to integrate it in your own themes and plugins.
- Move a file into a folder
- Create folders
- Move folders
- Get attachments in a folder
- ...
include('wp-content/plugins/wp-media-folder/helper.php');
\Joomunited\WPMediaFolder\Helper::createFolder('My new folder');
Hooks
import_term_meta
Fires after term meta is imported.
Parameters :
int $term_id ID of the newly created term.
string $key Meta key.
mixed $value Meta value.
Return :
void
In files :
class/import/class-wp-import.php line 451
wpmf_add_attachment
Create remote video file
Parameters :
integer Created attachment ID
integer|array Target folder
array Extra informations
Return :
void
In files :
class/class-main.php line 4530
wpmf_attachment_set_folder
Set attachment folder after moving an attachment to a folder in the media manager
This hook is also used when importing attachment to categories, after an attachment upload and
when assigning multiple folder to an attachment
Parameters :
integer Attachment ID
integer|array Target folder or array of target folders
array Extra informations
Return :
void
In files :
class/class-helper.php line 133
class/class-helper.php line 189
class/class-main.php line 685
class/class-main.php line 716
class/class-main.php line 2173
class/class-main.php line 2715
class/class-main.php line 3540
class/class-main.php line 4338
class/class-wp-folder-option.php line 367
class/class-wp-folder-option.php line 3186
wpmf_before_delete_folder
Before delete a folder
Parameters :
WP_Term Folder, this term is not available anymore as it as been deleted
Return :
void
In files :
class/class-main.php line 3374
class/class-main.php line 3441
wpmf_create_folder
Create a folder from media library
This hook is also used when syncing and importing files from FTP, creating user and role based folders
and importing from Nextgen Gallery
Parameters :
integer Created folder ID
string Created folder name
integer Parent folder ID
array Extra informations
Return :
void
In files :
class/class-main.php line 2150
class/class-main.php line 3186
class/class-wp-folder-option.php line 3061
wpmf_delete_folder
Delete a folder
Parameters :
WP_Term Folder, this term is not available anymore as it as been deleted
Return :
void
In files :
class/class-main.php line 3381
class/class-main.php line 3450
wpmf_duplicate_attachment
Duplicate an attachment
Parameters :
integer Attachment ID
integer Target folder
Return :
void
In files :
class/class-duplicate-file.php line 104
wpmf_move_folder
Move a folder from media library
This hook is also used when role folder option is changed
Parameters :
integer Folder moved ID
string Destination folder ID
array Extra informations
Return :
void
In files :
class/class-main.php line 3635
class/class-wp-folder-option.php line 2631
wpmf_update_folder_name
Update folder name
Parameters :
integer Folder ID
string Updated name
Return :
void
In files :
class/class-main.php line 3300
fallback_intermediate_image_sizes
Filters the image sizes generated for non-image mime types.
Parameters :
array $fallback_sizes An array of image size names.
array $metadata Current attachment metadata.
Return :
void
In files :
class/class-helper.php line 254
import_term_meta_key
Filters the meta key for an imported piece of term meta.
Parameters :
string $meta_key Meta key.
int $term_id ID of the newly created term.
array $term Term data from the WXR import.
Return :
void
In files :
class/import/class-wp-import.php line 432
the_content_export
Filters the post content used for WXR exports.
Parameters :
string $post_content Content of the current post.
Return :
void
In files :
class/class-wp-folder-option.php line 1261
the_excerpt_export
Filters the post excerpt used for WXR exports.
Parameters :
string $post_excerpt Excerpt for the current post.
Return :
void
In files :
class/class-wp-folder-option.php line 1270
wp_import_existing_post
Filter ID of the existing post corresponding to post currently importing.
Return 0 to force the post to be imported. Filter the ID to be something else
to override which existing post is mapped to the imported post.
Parameters :
int $post_exists Post ID, or 0 if post did not exist.
array $post The post array to be inserted.
Return :
void
In files :
class/import/class-wp-import.php line 505
wp_import_term_meta
Filters the metadata attached to an imported term.
Parameters :
array $termmeta Array of term meta.
int $term_id ID of the newly created term.
array $term Term data from the WXR import.
Return :
void
In files :
class/import/class-wp-import.php line 416
wpmf_gallery_enable_download
Filter to enable/disable download image on gallery
Parameters :
boolean Enable/disable download image
Return :
boolean
In files :
class/class-display-gallery.php line 453
wpmf_get_categories_args
Filter to custom aguments for get all categories
Parameters :
array Agument
Return :
array
In files :
class/class-main.php line 1744
wpmf_limit_folders
Filter to set limit of the folder number loaded
Parameters :
integer Limit folder number
Return :
integer
In files :
class/class-main.php line 1278
wpmf_set_file_title
Manipulate file title before saving it into database
Parameters :
string File title
Return :
string
In files :
class/class-main.php line 4459
wpmf_taxonomy_public
Filter to change public param wpmf-category taxonomy
Parameters :
boolean Toxonomy public status
Return :
boolean
In files :
wp-media-folder.php line 1349
wpmf_user_can
Filter check user capability to do an action
Parameters :
boolean The current user has the given capability
string Action name
Return :
boolean
In files :
wp-media-folder.php line 36
class/class-main.php line 876
class/class-main.php line 1140
class/class-main.php line 1178
class/class-main.php line 1292
class/class-main.php line 2027
class/class-main.php line 2061
class/class-main.php line 3150
class/class-main.php line 3247
class/class-main.php line 3327
class/class-main.php line 3488
class/class-main.php line 3581
class/class-main.php line 3671
class/class-main.php line 3953
class/class-main.php line 4086
class/class-main.php line 4276
class/class-main.php line 4513
class/class-main.php line 4755
class/class-main.php line 4802
class/class-replace-file.php line 45
class/class-replace-file.php line 213
class/class-image-watermark.php line 209
class/pages/settings/image_compression.php line 44
class/pages/settings/image_compression.php line 98
class/pages/settings/image_compression.php line 252
class/pages/settings/image_compression.php line 288
class/pages/settings/import_export.php line 152
class/pages/settings/import_export.php line 299
class/class-duplicate-file.php line 53
class/install-wizard/install-wizard.php line 54
class/class-wp-folder-option.php line 251
class/class-wp-folder-option.php line 940
class/class-wp-folder-option.php line 991
class/class-wp-folder-option.php line 1340
class/class-wp-folder-option.php line 1422
class/class-wp-folder-option.php line 2036
class/class-wp-folder-option.php line 3029
class/class-wp-folder-option.php line 3643
class/class-wp-folder-option.php line 3743
class/class-wp-folder-option.php line 3811
class/class-wp-folder-option.php line 3924
class/class-wp-folder-option.php line 3975
class/class-wp-folder-option.php line 4023
class/class-folder-access.php line 41
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/my-membership under the Composer token accordion.
{
"repositories":[
{
"type":"package",
"package":{
"name":"joomunited/wp-media-folder",
"version":"master",
"type":"wordpress-plugin",
"dist":{
"type":"zip",
"url":"https://www.joomunited.com/extra/download/wp-media-folder/YOUR_TOKEN",
"reference":"master"
}
}
}
],
"require":{
"composer/installers":"~1.0",
"joomunited/wp-media-folder":"dev-master"
}
}
Please not that composer update command can't work on private repositories (for more explanation please refer to the composer documentation)
Though, you can manually update the plugin to the latest version with this command:
composer remove joomunited/wp-media-folder && composer clearcache && composer require joomunited/wp-media-folder:dev-master
Set Update key programmatically with WP CLI
Use the same key you used for the composer installation and execute this composer command to set the update token
wp option update ju_user_token "YOUR_TOKEN"
