Envira Gallery Documentation

Documentation, Reference Materials and Tutorials for Envira Gallery

Action and Filter Hooks

All available actions and filters for Envira Gallery are listed below. Developers can call these using add_action and add_filter to customise or extend Envira’s functionality.

Filters

File Filter Name Arguments
/envira-gallery.php
envira_gallery_license_key apply_filters( ‘envira_gallery_license_key’, $key )
envira_gallery_default_options apply_filters( ‘envira_gallery_default_options’, $ret )
/includes/admin/ajax.php
envira_gallery_ajax_save_meta apply_filters( ‘envira_gallery_ajax_save_meta’, $gallery_data, $meta, $attach_id, $post_id )
envira_gallery_ajax_item_data apply_filters( ‘envira_gallery_ajax_item_data’, $gallery_data, $attachment, $id )
/includes/admin/common.php
envira_gallery_bulk_edit_save_settings apply_filters( ‘envira_gallery_bulk_edit_save_settings’, $settings, $post_id )
/includes/admin/export.php
envira_gallery_export_cap apply_filters( ‘envira_gallery_export_cap’, $manage_options )
/includes/admin/import.php
envira_gallery_imported_image_data apply_filters( ‘envira_gallery_imported_image_data’, $data, $id, $item, $post_id )
envira_gallery_remote_image_import_only_error apply_filters( ‘envira_gallery_remote_image_import_only_error’, $stream )
envira_gallery_remote_image_import_only apply_filters( ‘envira_gallery_remote_image_import_only’, $mirror, $attach_data, $attach_id )
envira_gallery_remote_image_import apply_filters( ‘envira_gallery_remote_image_import’, $data, $src, $id )
envira_gallery_image_purged apply_filters( ‘envira_gallery_image_purged’, $data, $id )
envira_gallery_import_cap apply_filters( ‘envira_gallery_import_cap’, $manage_options )
/includes/admin/metaboxes.php
envira_gallery_plupload_init apply_filters( ‘envira_gallery_plupload_init’, $plupload_init, $post_id )
envira_gallery_metabox_ids apply_filters( ‘envira_gallery_metabox_ids’, $pass_over_defaults )
envira_gallery_metabox_contexts apply_filters( ‘envira_gallery_metabox_contexts’, $contexts_defaults )
envira_gallery_metabox_priorities apply_filters( ‘envira_gallery_metabox_priorities’, $priorities_defaults )
envira_gallery_tab_nav apply_filters( ‘envira_gallery_tab_nav’, $tabs )
envira_gallery_types apply_filters( ‘envira_gallery_types’, $types, $post )
envira_gallery_quick_edit_save_settings apply_filters( ‘envira_gallery_quick_edit_save_settings’, $settings, $post_id, $post )
envira_gallery_save_settings apply_filters( ‘envira_gallery_save_settings’, $settings, $post_id, $post )
envira_gallery_crop_image_args apply_filters( ‘envira_gallery_crop_image_args’, $args )
envira_gallery_skipped_posttypes apply_filters( ‘envira_gallery_skipped_posttypes’, $skipped_posttypes )
/includes/admin/posttype.php
envira_gallery_messages apply_filters( ‘envira_gallery_messages’, $envira_messages )
/includes/admin/settings.php
envira_gallery_menu_cap apply_filters( ‘envira_gallery_menu_cap’, ‘manage_options’ )
envira_gallery_settings_tab_nav apply_filters( ‘envira_gallery_settings_tab_nav’, $tabs )
/includes/global/common.php
envira_gallery_columns apply_filters( ‘envira_gallery_columns’, $columns )
envira_gallery_gallery_themes apply_filters( ‘envira_gallery_gallery_themes’, $themes )
envira_gallery_lightbox_themes apply_filters( ‘envira_gallery_lightbox_themes’, $themes )
envira_gallery_title_displays apply_filters( ‘envira_gallery_title_displays’, $displays )
envira_gallery_transition_effects apply_filters( ‘envira_gallery_transition_effects’, $effects )
envira_gallery_toolbar_positions apply_filters( ‘envira_gallery_toolbar_positions’, $positions )
envira_gallery_thumbnail_positions apply_filters( ‘envira_gallery_thumbnail_positions’, $positions )
envira_gallery_defaults apply_filters( ‘envira_gallery_defaults’, $defaults, $post_id )
/includes/global/posttype.php
envira_gallery_post_type_labels apply_filters( ‘envira_gallery_post_type_labels’, $labels )
envira_gallery_post_type_menu_position apply_filters( ‘envira_gallery_post_type_menu_position’, 247 )
envira_gallery_post_type_args apply_filters( ‘envira_gallery_post_type_args’, $args )
/includes/global/shortcode.php
envira_gallery_custom_gallery_data apply_filters( ‘envira_gallery_custom_gallery_data’, false, $atts, $post )
envira_gallery_pre_data apply_filters( ‘envira_gallery_pre_data’, $data, $gallery_id )
envira_gallery_output_start apply_filters( ‘envira_gallery_output_start’, $gallery, $data )
envira_gallery_output_before_container apply_filters( ‘envira_gallery_output_before_container’, $gallery, $data )
envira_gallery_output_item_data apply_filters( ‘envira_gallery_output_item_data’, $item, $id, $data, $i )
envira_gallery_output_before_item apply_filters( ‘envira_gallery_output_before_item’, $gallery, $id, $item, $data, $i )
envira_gallery_output_item_attr apply_filters( ‘envira_gallery_output_item_attr’, ”, $id, $item, $data, $i )
envira_gallery_output_before_link apply_filters( ‘envira_gallery_output_before_link’, $output, $id, $item, $data, $i )
envira_gallery_output_link_attr apply_filters( ‘envira_gallery_output_link_attr’, ”, $id, $item, $data, $i )
envira_gallery_output_before_image apply_filters( ‘envira_gallery_output_before_image’, $output, $id, $item, $data, $i )
envira_gallery_output_image_attr apply_filters( ‘envira_gallery_output_image_attr’, ”, $id, $item, $data, $i )
envira_gallery_output_after_image apply_filters( ‘envira_gallery_output_after_image’, $output, $id, $item, $data, $i )
envira_gallery_output_after_link apply_filters( ‘envira_gallery_output_after_link’, $output, $id, $item, $data, $i )
envira_gallery_output_single_item apply_filters( ‘envira_gallery_output_single_item’, $output, $id, $item, $data, $i )
envira_gallery_output_after_item apply_filters( ‘envira_gallery_output_after_item’, $gallery, $id, $item, $data, $i )
envira_gallery_output_after_container apply_filters( ‘envira_gallery_output_after_container’, $gallery, $data )
envira_gallery_output_end apply_filters( ‘envira_gallery_output_end’, $gallery, $data )
envira_gallery_output apply_filters( ‘envira_gallery_output’, $gallery, $data )
envira_gallery_output_before_description apply_filters( ‘envira_gallery_output_before_description’, $gallery, $data )
envira_gallery_output_after_description apply_filters( ‘envira_gallery_output_after_description’, $gallery, $data )
envira_gallery_output_classes apply_filters( ‘envira_gallery_output_classes’, $classes, $data )
envira_gallery_output_item_classes apply_filters( ‘envira_gallery_output_item_classes’, $classes, $item, $i, $data )
envira_gallery_no_image_src apply_filters( ‘envira_gallery_no_image_src’, $item[‘link’], $id, $item, $data )
envira_gallery_crop_image_args apply_filters( ‘envira_gallery_crop_image_args’, $args)
envira_gallery_image_src apply_filters( ‘envira_gallery_image_src’, $resized_image, $id, $item, $data )
envira_gallery_toolbar_start apply_filters( ‘envira_gallery_toolbar_start’, $template, $data )
envira_gallery_toolbar_after_prev apply_filters( ‘envira_gallery_toolbar_after_prev’, $template, $data )
envira_gallery_toolbar_after_next apply_filters( ‘envira_gallery_toolbar_after_next’, $template, $data )
envira_gallery_toolbar_after_title apply_filters( ‘envira_gallery_toolbar_after_title’, $template, $data )
envira_gallery_toolbar_after_close apply_filters( ‘envira_gallery_toolbar_after_close’, $template, $data )
envira_gallery_toolbar_end apply_filters( ‘envira_gallery_toolbar_end’, $template, $data )
envira_gallery_toolbar apply_filters( ‘envira_gallery_toolbar’, $template, $data )
envira_gallery_lightbox_template apply_filters( ‘envira_gallery_lightbox_template’, $template, $data )
envira_gallery_minified_string apply_filters( ‘envira_gallery_minified_string’, $clean, $string )
envira_gallery_feed_output apply_filters( ‘envira_gallery_feed_output’, $gallery, $data )
envira_gallery_indexable_images apply_filters( ‘envira_gallery_indexable_images’, $images, $this->index, $id )
/includes/global/widget.php
envira_gallery_widget_name apply_filters( ‘envira_gallery_widget_name’, $widget_name )
envira_gallery_widget_ops apply_filters( ‘envira_gallery_widget_ops’, $widget_ops )
envira_gallery_widget_control_ops apply_filters( ‘envira_gallery_widget_control_ops’, $control_ops )
envira_gallery_widget_update_instance apply_filters( ‘envira_gallery_widget_update_instance’, $instance, $new_instance )

Actions

File Filter Name Arguments
/envira-gallery.php
envira_gallery_pre_init do_action( ‘envira_gallery_pre_init’ )
envira_gallery_init do_action( ‘envira_gallery_init’ )
envira_gallery_loaded do_action( ‘envira_gallery_loaded’ )
envira_gallery_updater do_action( ‘envira_gallery_updater’, $key )
/includes/admin/ajax.php
envira_gallery_ajax_load_image do_action( ‘envira_gallery_ajax_load_image’, $id, $post_id )
envira_gallery_ajax_insert_images do_action( ‘envira_gallery_ajax_insert_images’, $images, $post_id )
envira_gallery_ajax_remove_images do_action( ‘envira_gallery_ajax_remove_images’, $attach_id, $post_id )
/includes/admin/common.php
envira_gallery_admin_styles do_action( ‘envira_gallery_admin_styles’ )
envira_gallery_trash do_action( ‘envira_gallery_trash’, $id, $gallery_data )
envira_gallery_untrash do_action( ‘envira_gallery_untrash’, $id, $gallery_data )
/includes/admin/metaboxes.php
envira_gallery_metabox_styles do_action( ‘envira_gallery_metabox_styles’ )
envira_gallery_metabox_scripts do_action( ‘envira_gallery_metabox_scripts’ )
envira_gallery_admin_css do_action( ‘envira_gallery_admin_css’ )
envira_gallery_tab_ do_action( ‘envira_gallery_tab_’ . $id, $post )
envira_gallery_display_ do_action( ‘envira_gallery_display_’ . $type, $post )
envira_gallery_modal_router do_action( ‘envira_gallery_modal_router’, $post )
envira_gallery_config_box do_action( ‘envira_gallery_config_box’, $post )
envira_gallery_lightbox_box do_action( ‘envira_gallery_lightbox_box’, $post )
envira_gallery_thumbnails_box do_action( ‘envira_gallery_thumbnails_box’, $post )
envira_gallery_misc_box do_action( ‘envira_gallery_misc_box’, $post )
envira_gallery_saved_settings do_action( ‘envira_gallery_saved_settings’, $settings, $post_id, $post )
envira_gallery_before_meta_help do_action( ‘envira_gallery_before_meta_help’, $id, $data, $post_id )
envira_gallery_before_meta_help_items do_action( ‘envira_gallery_before_meta_help_items’, $id, $data, $post_id )
envira_gallery_after_meta_help_items do_action( ‘envira_gallery_after_meta_help_items’, $id, $data, $post_id )
envira_gallery_after_meta_help do_action( ‘envira_gallery_after_meta_help’, $id, $data, $post_id )
envira_gallery_before_meta_table do_action( ‘envira_gallery_before_meta_table’, $id, $data, $post_id )
envira_gallery_before_meta_settings do_action( ‘envira_gallery_before_meta_settings’, $id, $data, $post_id )
envira_gallery_after_meta_settings do_action( ‘envira_gallery_after_meta_settings’, $id, $data, $post_id )
envira_gallery_after_meta_table do_action( ‘envira_gallery_after_meta_table’, $id, $data, $post_id )
/includes/admin/settings.php
envira_gallery_settings_styles do_action( ‘envira_gallery_settings_styles’ )
envira_gallery_settings_scripts do_action( ‘envira_gallery_settings_scripts’ )
envira_gallery_tab_settings_ do_action( ‘envira_gallery_tab_settings_’ . $id )
envira_gallery_settings_general_box do_action( ‘envira_gallery_settings_general_box’ )
/includes/global/common.php
envira_gallery_flush_caches do_action( ‘envira_gallery_flush_caches’, $post_id, $slug )
/includes/global/shortcode.php
envira_gallery_before_output do_action( ‘envira_gallery_before_output’, $data )
envira_gallery_api_start_global do_action( ‘envira_gallery_api_start_global’ )
envira_gallery_api_start do_action( ‘envira_gallery_api_start’, $data )
envira_gallery_api_enviratope_config do_action( ‘envira_gallery_api_enviratope_config’, $data )
envira_gallery_api_enviratope do_action( ‘envira_gallery_api_enviratope’, $data )
envira_gallery_api_config do_action( ‘envira_gallery_api_config’, $data )
envira_gallery_api_envirabox_config do_action( ‘envira_gallery_api_envirabox_config’, $data )
envira_gallery_api_helper_config do_action( ‘envira_gallery_api_helper_config’, $data )
envira_gallery_api_title_config do_action( ‘envira_gallery_api_title_config’, $data )
envira_gallery_api_config_callback do_action( ‘envira_gallery_api_config_callback’, $data )
envira_gallery_api_before_load do_action( ‘envira_gallery_api_before_load’, $data )
envira_gallery_api_after_load do_action( ‘envira_gallery_api_after_load’, $data )
envira_gallery_api_before_show do_action( ‘envira_gallery_api_before_show’, $data )
envira_gallery_api_after_show do_action( ‘envira_gallery_api_after_show’, $data )
envira_gallery_api_before_close do_action( ‘envira_gallery_api_before_close’, $data )
envira_gallery_api_after_close do_action( ‘envira_gallery_api_after_close’, $data )
envira_gallery_api_on_update do_action( ‘envira_gallery_api_on_update’, $data )
envira_gallery_api_on_cancel do_action( ‘envira_gallery_api_on_cancel’, $data )
envira_gallery_api_on_play_start do_action( ‘envira_gallery_api_on_play_start’, $data )
envira_gallery_api_on_play_end do_action( ‘envira_gallery_api_on_play_end’, $data )
envira_gallery_api_lightbox do_action( ‘envira_gallery_api_lightbox’, $data )
envira_gallery_api_end do_action( ‘envira_gallery_api_end’, $data )
envira_gallery_api_end_global do_action( ‘envira_gallery_api_end_global’ )
/includes/global/widget.php
envira_gallery_widget_before_output do_action( ‘envira_gallery_widget_before_output’, $args, $instance )
envira_gallery_widget_before_title do_action( ‘envira_gallery_widget_before_title’, $args, $instance )
envira_gallery_widget_before_gallery do_action( ‘envira_gallery_widget_before_gallery’, $args, $instance )
envira_gallery_widget_after_gallery do_action( ‘envira_gallery_widget_after_gallery’, $args, $instance )
envira_gallery_widget_after_output do_action( ‘envira_gallery_widget_after_output’, $args, $instance )
envira_gallery_widget_before_form do_action( ‘envira_gallery_widget_before_form’, $instance )
envira_gallery_widget_middle_form do_action( ‘envira_gallery_widget_middle_form’, $instance )
envira_gallery_widget_after_form do_action( ‘envira_gallery_widget_after_form’, $instance )

Addons

To see the available Actions and Filters for a specific Addon, please refer to that Addon’s Documentation, which can be found in the left hand menu.