Filters
File
Filter Name
Description
/addons/tree-view/includes/global/class-media-library-organizer-tree-view-media.php
media_library_organizer_tree_view_media_context_menuDefines the menu items for the Tree View's Context Menu, triggered when a user right clicks on a Category in the Tree View.
media_library_organizer_tree_view_media_actionsDefines the AJAX actions supported by the Tree View. Any context menu items should have a corresponding action defined here.
media_library_organizer_tree_view_media_get_tree_view_taxonomyDefines the Taxonomy to display Terms for in the Tree View.
/includes/class-media-library-organizer.php
media_library_organizer_is_admin_or_frontend_editorFilters whether the current request is a WordPress Administration / Frontend Editor request or not. Page Builders can set this to true to allow Media Library Organizer and its Addons to load its functionality.
/includes/admin/class-media-library-organizer-notices.php
media_library_organizer_notices_get_success_noticesFilters the success notices to return.
media_library_organizer_notices_get_error_noticesFilters the error notices to return.
media_library_organizer_notices_get_noticesFilters the success and error notices to return.
media_library_organizer_notices_saveFilters the success and error notices to save.
/includes/admin/class-media-library-organizer-admin-ajax.php
media_library_organizer_admin_save_settings
/includes/admin/class-media-library-organizer-api.php
media_library_organizer_api_set_timeoutDefines the maximum time to allow the API request to run.
/includes/admin/class-media-library-organizer-admin.php
media_library_organizer_admin_body_classRegisters screen names that should add the wpzinc class to the tag
media_library_organizer_admin_admin_menu_minimum_capabilityDefines the minimum capability required to access the Media Library Organizer Menu and Sub Menus.
media_library_organizer_admin_get_screensDefine sections in the Plugin's Settings
media_library_organizer_admin_get_current_screen_ screenAdjust the screen data immediately before returning.
media_library_organizer_admin_get_screen_tabsDefine tabs in the Plugin Settings section.
media_library_organizer_admin_get_screen_addon_tabsDefine Addon tabs in the Plugin Settings section.
media_library_organizer_admin_save_settingsSave POSTed data on a Settings Screen
media_library_organizer_admin_save_settings_ screenSaves Settings for a non-setting screen.
/includes/global/class-media-library-organizer-upload.php
media_library_organizer_upload_plupload_optionsDefine the pluploader's options.
media_library_organizer_upload_filter_existing_attachment_data_before_saveFilters attachment post data for an existing Attachment before it is saved to the WordPress Media Library.
media_library_organizer_upload_filter_new_attachment_data_before_saveFilters attachment post data before a new Attachment is saved to the WordPress Media Library.
/includes/global/class-media-library-organizer-shortcode.php
media_library_organizer_shortcode_registerRegisters shortcodes.
media_library_organizer_shortcode_output_galleryAllows Addons to modify the [gallery] shortcode HTML If output is blank, WordPress' gallery_shortcode() will provide the output as a fallback.
/includes/global/class-media-library-organizer-media.php
media_library_organizer_media_output_list_table_filters_taxonomy_filter_argsDefine the wp_dropdown_categories() compatible arguments for the Media Categories Taxonomy Filter in the Media Library List View
media_library_organizer_media_output_list_table_filters_taxonomyFilters the HTML output produced by wp_dropdown_categories() in the Media Library List View immediately before it's output.
media_library_organizer_media_enqueue_js_css_selectize_selectorsDefines the selectize DOM selectors for various Selectize JS instances, such as Simple and AJAX implementations.
media_library_organizer_media_define_list_view_columnsDefines the Columns to display in the List View WP_List_Table.
media_library_organizer_media_define_list_view_columns_outputDefines the data to display in the List View WP_List_Table Column, for the given column and Attachment.
media_library_organizer_media_define_list_view_columns_output_ column_nameDefines the data to display in the List View WP_List_Table Column, for the given column and Attachment.
media_library_organizer_media_filter_attachments_gridDefines the arguments used when querying for Media in the Media Grid View.
media_library_organizer_media_filter_attachments_list_file_typeFilter Attachments by File Type, if a Filter has not yet been applied.
media_library_organizer_media_filter_attachmentsDefines the arguments used when querying for Media in the Media List View.
media_library_organizer_media_filter_attachments_where_clauseFilters Attachments in both List and Grid views by allowing the WHERE clause to be altered
media_library_organizer_media_attachment_edit_modal_form_fieldsDefines the fields to display when editing an Attachment in the modal.
media_library_organizer_media_show_attachment_countWhether to show Attachment counts for Terms on Taxonomy select dropdowns. We don't display these outside of WordPress Admin > Media, because the Attachment count will include all file types, meaning it's inaccurate when e.g. selecting a Featured Image for a Page/Post, as the media view will be restricted to images. Calculating counts by MIME type is expensive, so it's better not to show the count.
/includes/global/class-media-library-organizer-settings.php
media_library_organizer_settings_get_settingFilters the settings data for the given setting type and key before it is returned.
media_library_organizer_settings_get_settingsFilters the settings data for the given setting type before it is returned.
media_library_organizer_settings_update_settingDefines the setting data just before it is saved for the given type and key.
media_library_organizer_settings_update_settingsDefines the settings data just before it is saved for the given type.
media_library_organizer_settings_delete_settingFilters the setting data just before it is deleted.
media_library_organizer_settings_get_default_settingsDefines the default settings for the given type.
/includes/global/class-media-library-organizer-user-option.php
media_library_organizer_user_option_get_optionFilter the value returned for a User Option.
media_library_organizer_user_option_update_optionFilter the value just before saving a User Option.
media_library_organizer_user_option_get_default_optionFilter the default value returned for a User Option, when no saved option value exists.
media_library_organizer_user_option_get_default_optionsFilter the default options to be applied where no saved option value exists.
/includes/global/class-media-library-organizer-dynamic-tags.php
media_library_organizer_dynamic_tags_getReturns an array of tags that can be used as an attribute's value. Tags are then dynamically replaced with file data.
media_library_organizer_dynamic_tags_register_all_possible_searches_replacementsRegister tags and their replacement values for the given Attachment.
media_library_organizer_dynamic_tags_register_filename_searches_replacementsRegisters tags and their data replacements for the given Attachment's filename.
media_library_organizer_dynamic_tags_register_author_searches_replacementsRegisters tags and their data replacements for the given Attachment's author.
/includes/global/class-media-library-organizer-taxonomies.php
media_library_organizer_taxonomy_register_taxonomyDefines the parameters for registering the Media Categories Taxonomy
media_library_organizer_taxonomies_registerDefines Taxonomies to Register against Attachments
/includes/global/class-media-library-organizer-filesystem.php
media_library_organizer_common_get_tmp_folderDefines the temporary server folder location to use for file operations.
/includes/global/class-media-library-organizer-common.php
media_library_organizer_defaults_common_get_autocomplete_enabled_fieldsDefines an array of Javascript DOM selectors to enable the keyword autocomplete functionality on.
media_library_organizer_common_get_author_optionsDefines the available Author options.
media_library_organizer_common_get_operator_optionsDefines the available comparison operator options.
media_library_organizer_common_get_position_optionsDefines the available layout position options.
media_library_organizer_common_get_file_type_optionsDefines the available file type options for WP_Query calls
media_library_organizer_common_get_orderby_optionsDefines the available WP_Query compatible order by options.
media_library_organizer_common_get_orderby_defaultDefines the default order_by value for WP_Query queries
media_library_organizer_common_get_order_optionsDefines the available WP_Query compatible order options.
media_library_organizer_common_get_order_defaultDefines the default order_by value for WP_Query queries
media_library_organizer_common_get_attachment_display_settings_alignment
media_library_organizer_common_get_attachment_display_settings_link_toDefines the available Attachment Display Settings: Link To options.
media_library_organizer_common_get_attachment_display_settings_sizeDefines the available WordPress registered Image Sizes.
media_library_organizer_common_get_terms_hierarchicalDefines the available hierarchical terms for the given Taxonomy.
media_library_organizer_common_get_media_viewDefines the current Media View the user is on (either list or grid).
/includes/global/class-media-library-organizer-mime.php
media_library_organizer_mime_get_file_typesDefines top level file types, such as Images, Videos, Audio and Documents.
media_library_organizer_mime_get_all_file_typesDefines all file types
media_library_organizer_mime_get_image_file_typesDefines image file types
media_library_organizer_mime_get_video_file_typesDefines video file types
media_library_organizer_mime_get_text_file_typesDefines text file types
media_library_organizer_mime_get_audio_file_typesDefines audio file types
media_library_organizer_mime_get_document_file_typesDefines image types
media_library_organizer_mime_get_spreadsheet_file_typesDefines image types
media_library_organizer_mime_get_presentation_file_typesDefines image types
media_library_organizer_mime_get_archive_file_typesDefines archive file types
Overview
Defines the menu items for the Tree View's Context Menu, triggered when a user right clicks on a Category in the Tree View.
Parameters
Parameter
Type
Description
$context_menu
mixed
Context Menu (false: none, array).
Usage
add_filter( 'media_library_organizer_tree_view_media_context_menu', function( $context_menu ) {
// ... your code here
// Return value
return $context_menu;
}, 10, 1 ); Overview
Defines the AJAX actions supported by the Tree View. Any context menu items should have a corresponding action defined here.
Parameters
Parameter
Type
Description
$actions
array
Actions.
Usage
add_filter( 'media_library_organizer_tree_view_media_actions', function( $actions ) {
// ... your code here
// Return value
return $actions;
}, 10, 1 ); Overview
Defines the Taxonomy to display Terms for in the Tree View.
Parameters
Parameter
Type
Description
$taxonomy_name
string
Taxonomy Name.
Usage
add_filter( 'media_library_organizer_tree_view_media_get_tree_view_taxonomy', function( 'mlo-category' ) {
// ... your code here
// Return value
return 'mlo-category';
}, 10, 1 ); Overview
Filters whether the current request is a WordPress Administration / Frontend Editor request or not. Page Builders can set this to true to allow Media Library Organizer and its Addons to load its functionality.
Parameters
Parameter
Type
Description
$is_admin_or_frontend_editor
bool
Is WordPress Administration / Frontend Editor request.
$request
array
Sanitized request data.
Usage
add_filter( 'media_library_organizer_is_admin_or_frontend_editor', function( $is_admin_or_frontend_editor, $request ) {
// ... your code here
// Return value
return $is_admin_or_frontend_editor;
}, 10, 2 ); Overview
Filters the success notices to return.
Parameters
Parameter
Type
Description
$success_notices
array
Success Notices.
$notices
object
Success and Error Notices.
Usage
add_filter( 'media_library_organizer_notices_get_success_notices', function( $success_notices, $notices ) {
// ... your code here
// Return value
return $success_notices;
}, 10, 2 ); Overview
Filters the error notices to return.
Parameters
Parameter
Type
Description
$error_notices
array
Error Notices.
$notices
object
Success and Error Notices.
Usage
add_filter( 'media_library_organizer_notices_get_error_notices', function( $error_notices, $notices ) {
// ... your code here
// Return value
return $error_notices;
}, 10, 2 ); Overview
Filters the success and error notices to return.
Parameters
Parameter
Type
Description
$notices
array
Success and Error Notices.
Usage
add_filter( 'media_library_organizer_notices_get_notices', function( $notices ) {
// ... your code here
// Return value
return $notices;
}, 10, 1 ); Overview
Filters the success and error notices to save.
Parameters
Parameter
Type
Description
$notices
array
Success and Error Notices.
Usage
add_filter( 'media_library_organizer_notices_save', function( $notices ) {
// ... your code here
// Return value
return $notices;
}, 10, 1 ); Parameters
Parameter
Type
Description
true
Unknown
N/A
$settings
Unknown
N/A
Usage
add_filter( 'media_library_organizer_admin_save_settings', function( true, $settings ) {
// ... your code here
// Return value
return true;
}, 10, 2 ); Overview
Defines the maximum time to allow the API request to run.
Parameters
Parameter
Type
Description
$timeout
int
Timeout, in seconds.
Usage
add_filter( 'media_library_organizer_api_set_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
media_library_organizer_admin_body_class
/includes/admin/class-media-library-organizer-admin.php::97
Overview
Registers screen names that should add the wpzinc class to the
tagParameters
Parameter
Type
Description
$screens
array
Screen Names.
Usage
add_filter( 'media_library_organizer_admin_body_class', function( $screens ) {
// ... your code here
// Return value
return $screens;
}, 10, 1 ); Overview
Defines the minimum capability required to access the Media Library Organizer Menu and Sub Menus.
Parameters
Parameter
Type
Description
$capability
string
Minimum Required Capability.
Usage
add_filter( 'media_library_organizer_admin_admin_menu_minimum_capability', function( $minimum_capability ) {
// ... your code here
// Return value
return $minimum_capability;
}, 10, 1 ); Overview
Define sections in the Plugin's Settings
Parameters
Parameter
Type
Description
$screens
array
Registered Plugin Screens.
Usage
add_filter( 'media_library_organizer_admin_get_screens', function( $screens ) {
// ... your code here
// Return value
return $screens;
}, 10, 1 ); Overview
Adjust the screen data immediately before returning.
Parameters
Parameter
Type
Description
$screens[
array
$screen
$screen
string
Screen Name.
Usage
add_filter( 'media_library_organizer_admin_get_current_screen_ screen', function( $screens[ $screen ], $screen ) {
// ... your code here
// Return value
return $screens[ $screen ];
}, 10, 2 ); Overview
Define tabs in the Plugin Settings section.
Parameters
Parameter
Type
Description
$tabs
array
Settings Tabs.
$screen
string
Current Screen Name to define Tabs for.
Usage
add_filter( 'media_library_organizer_admin_get_screen_tabs', function( $tabs, $screen ) {
// ... your code here
// Return value
return $tabs;
}, 10, 2 ); Overview
Define Addon tabs in the Plugin Settings section.
Parameters
Parameter
Type
Description
$tabs
array
Settings Tabs.
$screen
string
Current Screen Name to define Tabs for.
Usage
add_filter( 'media_library_organizer_admin_get_screen_addon_tabs', function( $addon_tabs, $screen ) {
// ... your code here
// Return value
return $addon_tabs;
}, 10, 2 ); Overview
Save POSTed data on a Settings Screen
Parameters
Parameter
Type
Description
$result
mixed
Result of saving data (true or WP_Error)
$_POST
array
Unfiltered $_POST data
Usage
add_filter( 'media_library_organizer_admin_save_settings', function( true, $_POST ) {
// ... your code here
// Return value
return true;
}, 10, 2 ); Overview
Saves Settings for a non-setting screen.
Parameters
Parameter
Type
Description
$result
mixed
Result of importing data (true or WP_Error).
$_POST
array
Unfiltered $_POST data to save.
Usage
add_filter( 'media_library_organizer_admin_save_settings_ screen', function( '', $_POST ) {
// ... your code here
// Return value
return '';
}, 10, 2 ); Overview
Define the pluploader's options.
Parameters
Parameter
Type
Description
$options
array
Plupload Options.
Usage
add_filter( 'media_library_organizer_upload_plupload_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Filters attachment post data for an existing Attachment before it is saved to the WordPress Media Library.
Parameters
Parameter
Type
Description
$data
array
Slashed, sanitized, and processed attachment post data.
$unprocessed_data
array
Slashed and sanitized attachment post data, but not processed.
Usage
add_filter( 'media_library_organizer_upload_filter_existing_attachment_data_before_save', function( $data, $unprocessed_data, $data['ID'] ) {
// ... your code here
// Return value
return $data;
}, 10, 3 ); Overview
Filters attachment post data before a new Attachment is saved to the WordPress Media Library.
Parameters
Parameter
Type
Description
$data
array
Slashed, sanitized, and processed attachment post data.
$unprocessed_data
array
Slashed and sanitized attachment post data, but not processed.
Usage
add_filter( 'media_library_organizer_upload_filter_new_attachment_data_before_save', function( $data, $unprocessed_data ) {
// ... your code here
// Return value
return $data;
}, 10, 2 ); Overview
Registers shortcodes.
Parameters
Parameter
Type
Description
$shortcodes
array
Shortcodes
Usage
add_filter( 'media_library_organizer_shortcode_register', function( $shortcodes ) {
// ... your code here
// Return value
return $shortcodes;
}, 10, 1 ); Overview
Allows Addons to modify the [gallery] shortcode HTML If output is blank, WordPress' gallery_shortcode() will provide the output as a fallback.
Parameters
Parameter
Type
Description
$output
string
HTML Output (if blank, gallery_shortcode() is used).
$atts
array
Shortcode Attributes.
$instance
?
Shortcode Instance.
Usage
add_filter( 'media_library_organizer_shortcode_output_gallery', function( $output, $atts, $instance ) {
// ... your code here
// Return value
return $output;
}, 10, 3 ); Overview
Define the wp_dropdown_categories() compatible arguments for the Media Categories Taxonomy Filter in the Media Library List View
Parameters
Parameter
Type
Description
$taxonomy_filters_args
array
wp_dropdown_categories() compatible arguments.
$taxonomy_name
string
Taxonomy Name.
Usage
add_filter( 'media_library_organizer_media_output_list_table_filters_taxonomy_filter_args', function( $taxonomy_filter_args, $taxonomy_name ) {
// ... your code here
// Return value
return $taxonomy_filter_args;
}, 10, 2 ); Overview
Filters the HTML output produced by wp_dropdown_categories() in the Media Library List View immediately before it's output.
Parameters
Parameter
Type
Description
$output
string
wp_dropdown_categories() HTML output
$args
array
wp_dropdown_categories() arguments
Usage
add_filter( 'media_library_organizer_media_output_list_table_filters_taxonomy', function( $output, $args ) {
// ... your code here
// Return value
return $output;
}, 10, 2 ); Overview
Defines the selectize DOM selectors for various Selectize JS instances, such as Simple and AJAX implementations.
Parameters
Parameter
Type
Description
$selectize_selectors
array
Selectize DOM Selectors.
Usage
add_filter( 'media_library_organizer_media_enqueue_js_css_selectize_selectors', function( $selectize_selectors ) {
// ... your code here
// Return value
return $selectize_selectors;
}, 10, 1 ); Overview
Defines the Columns to display in the List View WP_List_Table.
Parameters
Parameter
Type
Description
$columns
array
Columns.
$is_detached
bool
Is Attachment Detached.
Usage
add_filter( 'media_library_organizer_media_define_list_view_columns', function( $columns, $is_detached ) {
// ... your code here
// Return value
return $columns;
}, 10, 2 ); Overview
Defines the data to display in the List View WP_List_Table Column, for the given column and Attachment.
Parameters
Parameter
Type
Description
$output
string
Output.
$column_name
string
Column Name.
$id
int
Attachment ID.
Usage
add_filter( 'media_library_organizer_media_define_list_view_columns_output', function( $output, $column_name, $id ) {
// ... your code here
// Return value
return $output;
}, 10, 3 ); Overview
Defines the data to display in the List View WP_List_Table Column, for the given column and Attachment.
Parameters
Parameter
Type
Description
$output
string
Output.
$id
int
Attachment ID.
Usage
add_filter( 'media_library_organizer_media_define_list_view_columns_output_ column_name', function( $output, $id ) {
// ... your code here
// Return value
return $output;
}, 10, 2 ); Overview
Defines the arguments used when querying for Media in the Media Grid View.
Parameters
Parameter
Type
Description
$args
array
WP_Query compatible arguments.
$query
array
Request query, which may include custom attributes not included in $args.
Usage
add_filter( 'media_library_organizer_media_filter_attachments_grid', function( $args, $query ) {
// ... your code here
// Return value
return $args;
}, 10, 2 ); Overview
Filter Attachments by File Type, if a Filter has not yet been applied.
Parameters
Parameter
Type
Description
$query
WP_Query
WordPress Query.
$file_type
string
File Type.
Usage
add_filter( 'media_library_organizer_media_filter_attachments_list_file_type', function( $query, $file_type ) {
// ... your code here
// Return value
return $query;
}, 10, 2 ); Overview
Defines the arguments used when querying for Media in the Media List View.
Parameters
Parameter
Type
Description
$query
WP_Query
WordPress Query object.
$request
array
Sanitized $_REQUEST data.
Usage
add_filter( 'media_library_organizer_media_filter_attachments', function( $query, $request ) {
// ... your code here
// Return value
return $query;
}, 10, 2 ); Overview
Filters Attachments in both List and Grid views by allowing the WHERE clause to be altered
Parameters
Parameter
Type
Description
$where
string
WHERE Clause.
$query
WP_Query
WordPress Search Query.
Usage
add_filter( 'media_library_organizer_media_filter_attachments_where_clause', function( $where, $query ) {
// ... your code here
// Return value
return $where;
}, 10, 2 ); Overview
Defines the fields to display when editing an Attachment in the modal.
Parameters
Parameter
Type
Description
$form_fields
array
Form Fields.
$post
WP_Post
Attachment Post.
Usage
add_filter( 'media_library_organizer_media_attachment_edit_modal_form_fields', function( $form_fields, $post ) {
// ... your code here
// Return value
return $form_fields;
}, 10, 2 ); Overview
Whether to show Attachment counts for Terms on Taxonomy select dropdowns. We don't display these outside of WordPress Admin > Media, because the Attachment count will include all file types, meaning it's inaccurate when e.g. selecting a Featured Image for a Page/Post, as the media view will be restricted to images. Calculating counts by MIME type is expensive, so it's better not to show the count.
Parameters
Parameter
Type
Description
$show_attachment_count
bool
Show Attachment Count.
$screen
array
Screen.
Usage
add_filter( 'media_library_organizer_media_show_attachment_count', function( $show_attachment_count, $screen ) {
// ... your code here
// Return value
return $show_attachment_count;
}, 10, 2 ); Overview
Filters the settings data for the given setting type and key before it is returned.
Parameters
Parameter
Type
Description
$setting
mixed
Settings Data (string, array, object).
$type
string
Setting Type (option key).
$key
string
Setting Type Key (setting key within option value).
Usage
add_filter( 'media_library_organizer_settings_get_setting', function( $setting, $type, $key ) {
// ... your code here
// Return value
return $setting;
}, 10, 3 ); Overview
Filters the settings data for the given setting type before it is returned.
Parameters
Parameter
Type
Description
$settings
mixed
Settings Data (string, array, object).
$type
string
Setting Type (option key).
Usage
add_filter( 'media_library_organizer_settings_get_settings', function( $settings, $type ) {
// ... your code here
// Return value
return $settings;
}, 10, 2 ); Overview
Defines the setting data just before it is saved for the given type and key.
Parameters
Parameter
Type
Description
$value
mixed
Settings Data (string, array, object).
$type
string
Setting Type (option key).
$key
string
Setting Type Key (setting key within option value).
Usage
add_filter( 'media_library_organizer_settings_update_setting', function( $value, $type, $key ) {
// ... your code here
// Return value
return $value;
}, 10, 3 ); Overview
Defines the settings data just before it is saved for the given type.
Parameters
Parameter
Type
Description
$settings
mixed
Settings Data (string, array, object).
$type
string
Setting Type (option key).
Usage
add_filter( 'media_library_organizer_settings_update_settings', function( $settings, $type ) {
// ... your code here
// Return value
return $settings;
}, 10, 2 ); Overview
Filters the setting data just before it is deleted.
Parameters
Parameter
Type
Description
$value
mixed
Settings Data (string, array, object).
$type
string
Setting Type (option key).
$key
string
Setting Type Key (setting key within option value).
Usage
add_filter( 'media_library_organizer_settings_delete_setting', function( $settings, $type, $key ) {
// ... your code here
// Return value
return $settings;
}, 10, 3 ); Overview
Defines the default settings for the given type.
Parameters
Parameter
Type
Description
$defaults
array
Setting Defaults.
$type
string
Setting Type (option key).
Usage
add_filter( 'media_library_organizer_settings_get_default_settings', function( $defaults, $type ) {
// ... your code here
// Return value
return $defaults;
}, 10, 2 ); Overview
Filter the value returned for a User Option.
Parameters
Parameter
Type
Description
$value
string
Option Value
$option_name
string
Option Name
$user_id
int
User ID
Usage
add_filter( 'media_library_organizer_user_option_get_option', function( $value, $option_name, $user_id ) {
// ... your code here
// Return value
return $value;
}, 10, 3 ); Overview
Filter the value just before saving a User Option.
Parameters
Parameter
Type
Description
$value
string
Option Value.
$option_name
string
Option Name.
$user_id
int
User ID.
Usage
add_filter( 'media_library_organizer_user_option_update_option', function( $value, $option_name, $user_id ) {
// ... your code here
// Return value
return $value;
}, 10, 3 ); Overview
Filter the default value returned for a User Option, when no saved option value exists.
Parameters
Parameter
Type
Description
$default
mixed
Default Value.
$option_name
string
Option Name.
Usage
add_filter( 'media_library_organizer_user_option_get_default_option', function( $default, $option_name ) {
// ... your code here
// Return value
return $default;
}, 10, 2 ); Overview
Filter the default options to be applied where no saved option value exists.
Parameters
Parameter
Type
Description
$defaults
array
Default Option Key/Value Pairs.
Usage
add_filter( 'media_library_organizer_user_option_get_default_options', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 ); Overview
Returns an array of tags that can be used as an attribute's value. Tags are then dynamically replaced with file data.
Parameters
Parameter
Type
Description
$fields
array
Supported Fields.
Usage
add_filter( 'media_library_organizer_dynamic_tags_get', function( $tags ) {
// ... your code here
// Return value
return $tags;
}, 10, 1 ); Overview
Register tags and their replacement values for the given Attachment.
Parameters
Parameter
Type
Description
$searches_replacements
array
Searches (Tags) and Replacements (File Values).
$post
WP_Post
Attachment Post.
Usage
add_filter( 'media_library_organizer_dynamic_tags_register_all_possible_searches_replacements', function( $searches_replacements, $post ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 2 ); Overview
Registers tags and their data replacements for the given Attachment's filename.
Parameters
Parameter
Type
Description
$searches_replacements
array
Registered Supported Tags and their Replacements.
$post
WP_Post
WordPress Post.
Usage
add_filter( 'media_library_organizer_dynamic_tags_register_filename_searches_replacements', function( $searches_replacements, $post ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 2 ); Overview
Registers tags and their data replacements for the given Attachment's author.
Parameters
Parameter
Type
Description
$searches_replacements
array
Registered Supported Tags and their Replacements.
$author
WP_User
WordPress Author.
Usage
add_filter( 'media_library_organizer_dynamic_tags_register_author_searches_replacements', function( $searches_replacements, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 2 ); Overview
Defines the parameters for registering the Media Categories Taxonomy
Parameters
Parameter
Type
Description
$args
array
Arguments.
$taxonomy_name
string
Programmatic Taxonomy Name.
Usage
add_filter( 'media_library_organizer_taxonomy_register_taxonomy', function( $args, $taxonomy_name ) {
// ... your code here
// Return value
return $args;
}, 10, 2 ); Overview
Defines Taxonomies to Register against Attachments
Parameters
Parameter
Type
Description
$taxonomies
array
Taxonomies to Register
Usage
add_filter( 'media_library_organizer_taxonomies_register', function( $taxonomies ) {
// ... your code here
// Return value
return $taxonomies;
}, 10, 1 ); Overview
Defines the temporary server folder location to use for file operations.
Parameters
Parameter
Type
Description
$temporary_folder
string
Full Path to Temporary Folder
$sub_folder
string
Relative Path to optional Sub Folder (relative to Temporary Folder)
Usage
add_filter( 'media_library_organizer_common_get_tmp_folder', function( $temporary_folder, $sub_folder ) {
// ... your code here
// Return value
return $temporary_folder;
}, 10, 2 ); Overview
Defines an array of Javascript DOM selectors to enable the keyword autocomplete functionality on.
Parameters
Parameter
Type
Description
$fields
array
Supported Fields.
Usage
add_filter( 'media_library_organizer_defaults_common_get_autocomplete_enabled_fields', function( $fields ) {
// ... your code here
// Return value
return $fields;
}, 10, 1 ); Overview
Defines the available Author options.
Parameters
Parameter
Type
Description
$options
array
Authors (WordPress Users).
Usage
add_filter( 'media_library_organizer_common_get_author_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Defines the available comparison operator options.
Parameters
Parameter
Type
Description
$options
array
Comparison Operators
Usage
add_filter( 'media_library_organizer_common_get_operator_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Defines the available layout position options.
Parameters
Parameter
Type
Description
$options
array
Layout Positions
Usage
add_filter( 'media_library_organizer_common_get_position_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Defines the available file type options for WP_Query calls
Parameters
Parameter
Type
Description
$options
array
File Type Options.
$post_mime_types
array
Post MIME Types.
$avail_post_mime_types
array
Available Post MIME Types.
Usage
add_filter( 'media_library_organizer_common_get_file_type_options', function( $options, $post_mime_types, $avail_post_mime_types ) {
// ... your code here
// Return value
return $options;
}, 10, 3 ); Overview
Defines the available WP_Query compatible order by options.
Parameters
Parameter
Type
Description
$options
array
Order By Options.
Usage
add_filter( 'media_library_organizer_common_get_orderby_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Defines the default order_by value for WP_Query queries
Parameters
Parameter
Type
Description
$options
array
Layout Positions.
Usage
add_filter( 'media_library_organizer_common_get_orderby_default', function( $default ) {
// ... your code here
// Return value
return $default;
}, 10, 1 ); Overview
Defines the available WP_Query compatible order options.
Parameters
Parameter
Type
Description
$options
array
Order Options.
Usage
add_filter( 'media_library_organizer_common_get_order_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Defines the default order_by value for WP_Query queries
Parameters
Parameter
Type
Description
$options
array
Layout Positions.
Usage
add_filter( 'media_library_organizer_common_get_order_default', function( $default ) {
// ... your code here
// Return value
return $default;
}, 10, 1 ); Parameters
Parameter
Type
Description
$options
Unknown
N/A
Usage
add_filter( 'media_library_organizer_common_get_attachment_display_settings_alignment', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Defines the available Attachment Display Settings: Link To options.
Parameters
Parameter
Type
Description
$options
array
Attachment Display Settings: Link To Options.
Usage
add_filter( 'media_library_organizer_common_get_attachment_display_settings_link_to', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Defines the available WordPress registered Image Sizes.
Parameters
Parameter
Type
Description
$options
array
Attachment Display Settings: Link To Options.
Usage
add_filter( 'media_library_organizer_common_get_attachment_display_settings_size', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 ); Overview
Defines the available hierarchical terms for the given Taxonomy.
Parameters
Parameter
Type
Description
$hierarchical_terms
array
Hierarchical Terms.
Usage
add_filter( 'media_library_organizer_common_get_terms_hierarchical', function( $hierarchical_terms, $taxonomy, $hierarchy ) {
// ... your code here
// Return value
return $hierarchical_terms;
}, 10, 3 ); Overview
Defines the current Media View the user is on (either list or grid).
Parameters
Parameter
Type
Description
$media_view
string
Media View.
Usage
add_filter( 'media_library_organizer_common_get_media_view', function( $media_view ) {
// ... your code here
// Return value
return $media_view;
}, 10, 1 ); Overview
Defines top level file types, such as Images, Videos, Audio and Documents.
Parameters
Parameter
Type
Description
$file_types
array
File Types.
Usage
add_filter( 'media_library_organizer_mime_get_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Overview
Defines all file types
Parameters
Parameter
Type
Description
$file_types
array
All File Types.
Usage
add_filter( 'media_library_organizer_mime_get_all_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Overview
Defines image file types
Parameters
Parameter
Type
Description
$file_types
array
Image File Types.
Usage
add_filter( 'media_library_organizer_mime_get_image_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Overview
Defines video file types
Parameters
Parameter
Type
Description
$file_types
array
Video File Types.
Usage
add_filter( 'media_library_organizer_mime_get_video_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 );
media_library_organizer_mime_get_text_file_types
/includes/global/class-media-library-organizer-mime.php::256
Overview
Defines text file types
Parameters
Parameter
Type
Description
$file_types
array
Text File Types.
Usage
add_filter( 'media_library_organizer_mime_get_text_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Overview
Defines audio file types
Parameters
Parameter
Type
Description
$file_types
array
Audio File Types.
Usage
add_filter( 'media_library_organizer_mime_get_audio_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Overview
Defines image types
Parameters
Parameter
Type
Description
$file_types
array
Document File Types.
Usage
add_filter( 'media_library_organizer_mime_get_document_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Overview
Defines image types
Parameters
Parameter
Type
Description
$file_types
array
Spreadsheet File Types.
Usage
add_filter( 'media_library_organizer_mime_get_spreadsheet_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Overview
Defines image types
Parameters
Parameter
Type
Description
$file_types
array
Presentation File Types.
Usage
add_filter( 'media_library_organizer_mime_get_presentation_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Overview
Defines archive file types
Parameters
Parameter
Type
Description
$file_types
array
Archive File Types.
Usage
add_filter( 'media_library_organizer_mime_get_archive_file_types', function( $file_types ) {
// ... your code here
// Return value
return $file_types;
}, 10, 1 ); Actions
Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_admin_output_settings_panel_general', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_admin_output_settings_panel_user_options', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_admin_output_settings_panels', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_import_view_ import_sourcename', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_notices_delete_notices', function( ) {
// ... your code here
}, 10, 0 ); Overview
Enqueue Javascript for the given screen and Media View mode.
Parameters
Parameter
Type
Description
$screen
WP_Screen
Current WordPress Screen object.
$screens
array
Registered Plugin Screens (optional).
$mode
string
Media View Mode (list|grid).
$ext
string
If defined, load minified JS.
Usage
add_action( 'media_library_organizer_admin_scripts_js', function( $screen, $screens, $mode, $ext ) {
// ... your code here
}, 10, 4 ); Overview
Enqueue Javascript for the given screen and Media View mode by Plugin Screen Name.
Parameters
Parameter
Type
Description
$screen
WP_Screen
Current WordPress Screen object.
$screens
array
Registered Plugin Screens (optional).
$mode
string
Media View Mode (list|grid).
$ext
string
If defined, load minified JS
Usage
add_action( 'media_library_organizer_admin_scripts_js_ plugin_screen_name', function( $screen, $screens, $mode, $ext ) {
// ... your code here
}, 10, 4 ); Overview
Enqueue Stylesheets (CSS) for the given screen and Media View mode.
Parameters
Parameter
Type
Description
$screen
WP_Screen
Current WordPress Screen object.
$screens
array
Registered Plugin Screens (optional).
$mode
string
Media View Mode (list|grid).
Usage
add_action( 'media_library_organizer_admin_scripts_css', function( $screen, $screens, $mode ) {
// ... your code here
}, 10, 3 ); Overview
Enqueue Stylesheets (CSS) for the given screen and Media View mode.
Parameters
Parameter
Type
Description
$screen
WP_Screen
Current WordPress Screen object.
$screens
array
Registered Plugin Screens (optional).
$mode
string
Media View Mode (list|grid).
Usage
add_action( 'media_library_organizer_admin_scripts_css_ plugin_screen_name', function( $screen, $screens, $mode ) {
// ... your code here
}, 10, 3 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_admin_menu_import_export', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_admin_menu_support', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_upload_output_upload_ui', function( ) {
// ... your code here
}, 10, 0 ); Overview
Allows Addons to run actions on an attachment that has just been uploaded to the WordPress Media Library
Parameters
Parameter
Type
Description
$attachment_id
int
Attachment ID.
Usage
add_action( 'media_library_organizer_upload_add_attachment', function( $attachment_id ) {
// ... your code here
}, 10, 1 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_shortcode_reregister_gallery_filters', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_media_output_list_table_filters', function( ) {
// ... your code here
}, 10, 0 ); Overview
Enqueue JS and CSS for Media Views.
Parameters
Parameter
Type
Description
$ext
string
If defined, output minified JS and CSS
Usage
add_action( 'media_library_organizer_media_enqueue_js_css', function( $ext ) {
// ... your code here
}, 10, 1 ); Overview
Adds Meta Boxes to the Attachment Edit view.
Parameters
Parameter
Type
Description
$post
WP_Post
Attachment Post.
Usage
add_action( 'media_library_organizer_media_attachment_edit_form_fields', function( $post ) {
// ... your code here
}, 10, 1 ); Overview
Save Meta Box fields when saving an Attachment
Parameters
Parameter
Type
Description
$post
WP_Post
Attachment Post.
Usage
add_action( 'media_library_organizer_media_attachment_save_fields', function( $post_id ) {
// ... your code here
}, 10, 1 ); Overview
Save form field data from the Attachment modal or Quick Edit Form against the Attachment.
Parameters
Parameter
Type
Description
$post
array
Attachment Post.
$attachment
array
Attachment $_POST['attachment'] data (not used).
$request
array
Sanitized Form Fields Data
Usage
add_action( 'media_library_organizer_media_attachment_edit_modal_save_fields', function( $post, $attachment, $request ) {
// ... your code here
}, 10, 3 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_media_print_media_templates', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_media_media_library_footer', function( ) {
// ... your code here
}, 10, 0 ); Overview
Runs actions after a Settings Type is deleted.
Parameters
Parameter
Type
Description
$type
string
Setting Type (option key).
Usage
add_action( 'media_library_organizer_settings_delete_settings', function( $type ) {
// ... your code here
}, 10, 1 ); Overview
Runs actions before a User option is deleted.
Parameters
Parameter
Type
Description
$user_id
int
User ID.
$option_name
string
Option Name.
Usage
add_action( 'media_library_organizer_user_options_delete_option', function( $user_id, $option_name ) {
// ... your code here
}, 10, 2 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_frontend_enqueue_scripts', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_frontend_enqueue_css', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'media_library_organizer_editor_output_media_buttons', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
$file
Unknown
N/A
$post_id
Unknown
N/A
Usage
add_action( 'media_library_organizer_filesystem_add_file_as_attachment_remove_actions', function( $file, $post_id ) {
// ... your code here
}, 10, 2 ); Parameters
Parameter
Type
Description
$file
Unknown
N/A
$post_id
Unknown
N/A
$result
Unknown
N/A
Usage
add_action( 'media_library_organizer_filesystem_add_file_as_attachment_restore_actions', function( $file, $post_id, $result ) {
// ... your code here
}, 10, 3 );
