Home
WordPress products
Joomla products
Support
News
LoginWP 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 449
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-main.php line 478
class/class-main.php line 509
class/class-main.php line 1726
class/class-main.php line 2167
class/class-main.php line 2569
class/class-main.php line 2625
class/class-main.php line 2699
class/class-main.php line 3499
class/class-wp-folder-option.php line 312
class/class-wp-folder-option.php line 3065
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 2424
class/class-main.php line 2492
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 1703
class/class-main.php line 2275
class/class-wp-folder-option.php line 2962
class/class-wp-folder-option.php line 2996
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 2431
class/class-main.php line 2501
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 2786
class/class-wp-folder-option.php line 2550
wpmf_update_folder_name
Update folder name
Parameters :
integer Folder ID
string Updated name
Return :
void
In files :
class/class-main.php line 2357
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 143
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 430
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 1193
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 1202
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 503
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 414
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 3620
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 35
jutranslation/jutranslation.php line 109
class/install-wizard/install-wizard.php line 54
class/class-replace-file.php line 44
class/class-replace-file.php line 207
class/class-folder-access.php line 40
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 134
class/pages/settings/import_export.php line 168
class/class-main.php line 634
class/class-main.php line 862
class/class-main.php line 900
class/class-main.php line 1580
class/class-main.php line 1614
class/class-main.php line 2245
class/class-main.php line 2311
class/class-main.php line 2384
class/class-main.php line 2668
class/class-main.php line 2740
class/class-main.php line 2822
class/class-main.php line 3119
class/class-main.php line 3252
class/class-main.php line 3437
class/class-main.php line 3705
class/class-main.php line 4113
class/class-main.php line 4160
class/class-wp-folder-option.php line 196
class/class-wp-folder-option.php line 876
class/class-wp-folder-option.php line 927
class/class-wp-folder-option.php line 1272
class/class-wp-folder-option.php line 1353
class/class-wp-folder-option.php line 1966
class/class-wp-folder-option.php line 2925
class/class-wp-folder-option.php line 3215
class/class-wp-folder-option.php line 3298
class/class-wp-folder-option.php line 3345
class/class-wp-folder-option.php line 3429
class/class-wp-folder-option.php line 3480
class/class-wp-folder-option.php line 3528
class/class-image-watermark.php line 188
class/class-duplicate-file.php line 53
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-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
