Soliloquy Documentation

Documentation, Reference Materials, and Tutorials for Soliloquy

Hooks and Filters

All available Soliloquy hooks and filters are listed below. These always refer to the latest version, and we’ll be adding descriptions of each filter and action soon.

Filters

File Filter Name Arguments
/includes/admin/ajax.php
soliloquy_ajax_save_meta apply_filters( ‘soliloquy_ajax_save_meta’, $slider_data, $meta, $attach_id, $post_id )
soliloquy_ajax_item_data apply_filters( ‘soliloquy_ajax_item_data’, $slider_data, $id, $type )
/includes/admin/editor.php
soliloquy_media_button apply_filters( ‘soliloquy_media_button’, $button )
/includes/admin/export.php
soliloquy_export_cap apply_filters( ‘soliloquy_export_cap’, current_user_can( ‘manage_options’ )
/includes/admin/import.php
soliloquy_imported_image_data apply_filters( ‘soliloquy_imported_image_data’, $data, $id, $item, $post_id )
soliloquy_remote_image_import_only_error apply_filters( ‘soliloquy_remote_image_import_only_error’, $mirror )
soliloquy_remote_image_import_only apply_filters( ‘soliloquy_remote_image_import_only’, $mirror, $attach_data, $attach_id )
soliloquy_remote_image_import apply_filters( ‘soliloquy_remote_image_import’, $data, $src, $id )
soliloquy_image_purged apply_filters( ‘soliloquy_image_purged’, $data, $id )
soliloquy_import_cap apply_filters( ‘soliloquy_import_cap’, current_user_can( ‘manage_options’ )
/includes/admin/metaboxes.php
soliloquy_plupload_init apply_filters( ‘soliloquy_plupload_init’, $plupload_init, $post_id )
soliloquy_metabox_priority apply_filters( ‘soliloquy_metabox_priority’, ‘high’ )
soliloquy_tab_nav apply_filters( ‘soliloquy_tab_nav’, $tabs )
soliloquy_slider_types apply_filters( ‘soliloquy_slider_types’, $types, $post )
soliloquy_save_settings apply_filters( ‘soliloquy_save_settings’, $settings, $post_id, $post )
soliloquy_crop_image_args apply_filters( ‘soliloquy_crop_image_args’, $args )
soliloquy_slide_item apply_filters( ‘soliloquy_slide_item’, $item, $id, $data, $type, $post_id )
soliloquy_cropped_image apply_filters( ‘soliloquy_cropped_image’, $image, $id, $item, $args, $post_id )
soliloquy_skipped_posttypes apply_filters( ‘soliloquy_skipped_posttypes’, $post_types )
/includes/admin/posttype.php
soliloquy_row_actions apply_filters( ‘soliloquy_row_actions’, $actions, $post )
soliloquy_messages apply_filters( ‘soliloquy_messages’, $messagesArr)
/includes/admin/settings.php
soliloquy_menu_cap apply_filters( ‘soliloquy_menu_cap’, ‘manage_options’ )
soliloquy_settings_tab_nav apply_filters( ‘soliloquy_settings_tab_nav’, $tabs )
/includes/global/common.php
soliloquy_slider_sizes apply_filters( ‘soliloquy_slider_sizes’, $sizes )
soliloquy_slider_themes apply_filters( ‘soliloquy_slider_themes’, $themes )
soliloquy_slider_transitions apply_filters( ‘soliloquy_slider_transitions’, $transitions )
soliloquy_slider_positions apply_filters( ‘soliloquy_slider_positions’, $positions )
soliloquy_defaults apply_filters( ‘soliloquy_defaults’, $defaults, $post_id )
soliloquy_meta_defaults apply_filters( ‘soliloquy_meta_defaults’, $defaults, $post_id, $attach_id )
soliloquy_get_image_info apply_filters( ‘soliloquy_get_image_info’, $image_info, $data )
/includes/global/posttype.php
soliloquy_post_type_labels apply_filters( ‘soliloquy_post_type_labels’, $labels )
soliloquy_post_type_menu_position apply_filters( ‘soliloquy_post_type_menu_position’, 248 )
soliloquy_post_type_args apply_filters( ‘soliloquy_post_type_args’, $args )
/includes/global/shortcode.php
soliloquy_custom_slider_data apply_filters( ‘soliloquy_custom_slider_data’, false, $atts, $post )
soliloquy_pre_data apply_filters( ‘soliloquy_pre_data’, $data, $slider_id )
soliloquy_output_start apply_filters( ‘soliloquy_output_start’, $slider, $data )
soliloquy_output_container_style apply_filters( ‘soliloquy_output_container_style’, ”, $data )
soliloquy_output_container_attr apply_filters( ‘soliloquy_output_container_attr’, ”, $data )
soliloquy_output_before_container apply_filters( ‘soliloquy_output_before_container’, $slider, $data )
soliloquy_output_item_data apply_filters( ‘soliloquy_output_item_data’, $item, $id, $data, $i )
soliloquy_output_before_item apply_filters( ‘soliloquy_output_before_item’, $slider, $id, $item, $data, $i )
soliloquy_output_item_attr apply_filters( ‘soliloquy_output_item_attr’, ”, $id, $item, $data, $i )
soliloquy_output_item_style apply_filters( ‘soliloquy_output_item_style’, ‘list-style:none;’, $id, $item, $data, $i )
soliloquy_output_single_item apply_filters( ‘soliloquy_output_single_item’, $output, $id, $item, $data, $i )
soliloquy_output_after_item apply_filters( ‘soliloquy_output_after_item’, $slider, $id, $item, $data, $i )
soliloquy_output_after_container apply_filters( ‘soliloquy_output_after_container’, $slider, $data )
soliloquy_output_end apply_filters( ‘soliloquy_output_end’, $slider, $data )
soliloquy_output_no_js apply_filters( ‘soliloquy_output_no_js’, $no_js_css, $data )
soliloquy_output apply_filters( ‘soliloquy_output’, $slider, $data )
soliloquy_output_slide apply_filters( ‘soliloquy_output_slide’, $slide, $id, $item, $data, $i )
soliloquy_output_before_link apply_filters( ‘soliloquy_output_before_link’, $output, $id, $item, $data, $i )
soliloquy_output_link_attr apply_filters( ‘soliloquy_output_link_attr’, ”, $id, $item, $data, $i )
soliloquy_output_before_image apply_filters( ‘soliloquy_output_before_image’, $output, $id, $item, $data, $i )
soliloquy_output_image_attr apply_filters( ‘soliloquy_output_image_attr’, ”, $id, $item, $data, $i )
soliloquy_output_after_image apply_filters( ‘soliloquy_output_after_image’, $output, $id, $item, $data, $i )
soliloquy_output_after_link apply_filters( ‘soliloquy_output_after_link’, $output, $id, $item, $data, $i )
soliloquy_output_before_caption apply_filters( ‘soliloquy_output_before_caption’, $output, $id, $item, $data, $i )
soliloquy_output_caption apply_filters( ‘soliloquy_output_caption’, $item[‘caption’], $id, $item, $data, $i )
soliloquy_output_after_caption apply_filters( ‘soliloquy_output_after_caption’, $output, $id, $item, $data, $i )
soliloquy_output_image_slide apply_filters( ‘soliloquy_output_image_slide’, $output, $id, $item, $data, $i )
soliloquy_output_video_error apply_filters( ‘soliloquy_output_video_error’, $error_message, $id, $item, $data, $i )
soliloquy_output_before_video apply_filters( ‘soliloquy_output_before_video’, $output, $id, $item, $data, $i )
soliloquy_output_after_video apply_filters( ‘soliloquy_output_after_video’, $output, $id, $item, $data, $i )
soliloquy_output_video_slide apply_filters( ‘soliloquy_output_video_slide’, $output, $id, $item, $data, $i )
soliloquy_video_source apply_filters( ‘soliloquy_video_source’, ”, $id, $item, $data )
soliloquy_video_id apply_filters( ‘soliloquy_video_id’, false, $source, $id, $item, $data )
soliloquy_video_url apply_filters( ‘soliloquy_video_url’, false, $source, $id, $item, $data )
soliloquy_video_data apply_filters( ‘soliloquy_video_data’, $ret, $id, $item, $data, $key )
soliloquy_output_before_html apply_filters( ‘soliloquy_output_before_html’, $output, $id, $item, $data, $i )
soliloquy_output_after_html apply_filters( ‘soliloquy_output_after_html’, $output, $id, $item, $data, $i )
soliloquy_output_html_slide apply_filters( ‘soliloquy_output_html_slide’, $output, $id, $item, $data, $i )
soliloquy_adaptive_height_speed apply_filters( ‘soliloquy_adaptive_height_speed’, 400, $data )
soliloquy_next_text apply_filters( ‘soliloquy_next_text’, ”, $data )
soliloquy_prev_text apply_filters( ‘soliloquy_prev_text’, ”, $data )
soliloquy_start_text apply_filters( ‘soliloquy_start_text’, ”, $data )
soliloquy_stop_text apply_filters( ‘soliloquy_stop_text’, ”, $data )
soliloquy_output_classes apply_filters( ‘soliloquy_output_classes’, $classes, $data )
soliloquy_output_item_classes apply_filters( ‘soliloquy_output_item_classes’, $classes, $item, $i, $data )
soliloquy_output_item_image_classes apply_filters( ‘soliloquy_output_item_image_classes’, $classes, $item, $i, $data, $mobile )
soliloquy_output_item_video_classes apply_filters( ‘soliloquy_output_item_video_classes’, $classes, $item, $i, $data, $vid_type, $mobile )
soliloquy_image_src apply_filters( ‘soliloquy_image_src’, $image, $id, $item, $data )
soliloquy_cropped_image apply_filters( ‘soliloquy_cropped_image’, $image, $id, $item, $data, $data[‘id’] )
soliloquy_no_image_src apply_filters( ‘soliloquy_no_image_src’, ”, $id, $item, $data )
soliloquy_crop_type apply_filters( ‘soliloquy_crop_type’, $type, $id, $item, $data )
soliloquy_no_image_type apply_filters( ‘soliloquy_no_image_type’, $item[‘link’], $id, $item, $data )
soliloquy_crop_image_args apply_filters( ‘soliloquy_crop_image_args’, $args )
soliloquy_video_thumbnail apply_filters( ‘soliloquy_video_thumbnail’, $thumb, $id, $item, $data )
soliloquy_position_style apply_filters( ‘soliloquy_position_style’, $position, $data )
soliloquy_minified_string apply_filters( ‘soliloquy_minified_string’, $clean, $string )
soliloquy_feed_output apply_filters( ‘soliloquy_feed_output’, $slider, $data )
soliloquy_youtube_args apply_filters( ‘soliloquy_youtube_args’, $args, $data )
soliloquy_vimeo_args apply_filters( ‘soliloquy_vimeo_args’, $args, $data )
soliloquy_wistia_args apply_filters( ‘soliloquy_wistia_args’, $args, $data )
soliloquy_indexable_images apply_filters( ‘soliloquy_indexable_images’, $images, $this->index, $id )
/includes/global/widget.php
soliloquy_widget_ops apply_filters( ‘soliloquy_widget_ops’, $widget_ops )
soliloquy_widget_control_ops apply_filters( ‘soliloquy_widget_control_ops’, $control_ops )
soliloquy_widget_name apply_filters( ‘soliloquy_widget_name’, __( ‘Soliloquy’, ‘soliloquy’ )
soliloquy_widget_update_instance apply_filters( ‘soliloquy_widget_update_instance’, $instance, $new_instance )
/soliloquy.php
soliloquy_license_key apply_filters( ‘soliloquy_license_key’, $key )
soliloquy_default_options apply_filters( ‘soliloquy_default_options’, $ret )

Actions

File Filter Name Arguments
/includes/admin/ajax.php
soliloquy_ajax_load_image do_action( ‘soliloquy_ajax_load_image’, $id, $post_id )
soliloquy_ajax_insert_slides do_action( ‘soliloquy_ajax_insert_slides’, $images, $videos, $html, $post_id )
soliloquy_ajax_remove_slide do_action( ‘soliloquy_ajax_remove_slide’, $attach_id, $post_id )
/includes/admin/metaboxes.php
soliloquy_metabox_styles do_action( ‘soliloquy_metabox_styles’ )
soliloquy_metabox_scripts do_action( ‘soliloquy_metabox_scripts’ )
soliloquy_admin_css do_action( ‘soliloquy_admin_css’ )
soliloquy_tab_ do_action( ‘soliloquy_tab_’ . $id, $post )
soliloquy_display_ do_action( ‘soliloquy_display_’ . $type, $post )
soliloquy_modal_router do_action( ‘soliloquy_modal_router’, $post )
soliloquy_modal_content do_action( ‘soliloquy_modal_content’, $post )
soliloquy_config_box do_action( ‘soliloquy_config_box’, $post )
soliloquy_misc_box do_action( ‘soliloquy_misc_box’, $post )
soliloquy_saved_settings do_action( ‘soliloquy_saved_settings’, $settings, $post_id, $post )
soliloquy_before_preview do_action( ‘soliloquy_before_preview’, $id, $data, $post_id )
soliloquy_after_preview do_action( ‘soliloquy_after_preview’, $id, $data, $post_id )
soliloquy_before_image_meta_table do_action( ‘soliloquy_before_image_meta_table’, $id, $data, $post_id )
soliloquy_before_meta_table do_action( ‘soliloquy_before_meta_table’, $id, $data, $post_id )
soliloquy_before_meta_settings do_action( ‘soliloquy_before_meta_settings’, $id, $data, $post_id )
soliloquy_before_image_meta_alt do_action( ‘soliloquy_before_image_meta_alt’, $id, $data, $post_id )
soliloquy_before_image_meta_link do_action( ‘soliloquy_before_image_meta_link’, $id, $data, $post_id )
soliloquy_before_image_meta_tab do_action( ‘soliloquy_before_image_meta_tab’, $id, $data, $post_id )
soliloquy_before_image_meta_caption do_action( ‘soliloquy_before_image_meta_caption’, $id, $data, $post_id )
soliloquy_after_image_meta_settings do_action( ‘soliloquy_after_image_meta_settings’, $id, $data, $post_id )
soliloquy_after_meta_settings do_action( ‘soliloquy_after_meta_settings’, $id, $data, $post_id )
soliloquy_after_image_meta_table do_action( ‘soliloquy_after_image_meta_table’, $id, $data, $post_id )
soliloquy_after_meta_table do_action( ‘soliloquy_after_meta_table’, $id, $data, $post_id )
soliloquy_before_video_meta_table do_action( ‘soliloquy_before_video_meta_table’, $id, $data, $post_id )
soliloquy_before_video_meta_url do_action( ‘soliloquy_before_video_meta_url’, $id, $data, $post_id )
soliloquy_before_video_meta_thumb do_action( ‘soliloquy_before_video_meta_thumb’, $id, $data, $post_id )
soliloquy_before_video_meta_caption do_action( ‘soliloquy_before_video_meta_caption’, $id, $data, $post_id )
soliloquy_after_video_meta_settings do_action( ‘soliloquy_after_video_meta_settings’, $id, $data, $post_id )
soliloquy_after_video_meta_table do_action( ‘soliloquy_after_video_meta_table’, $id, $data, $post_id )
soliloquy_before_html_meta_table do_action( ‘soliloquy_before_html_meta_table’, $id, $data, $post_id )
soliloquy_before_html_meta_code do_action( ‘soliloquy_before_html_meta_code’, $id, $data, $post_id )
soliloquy_after_html_meta_settings do_action( ‘soliloquy_after_html_meta_settings’, $id, $data, $post_id )
soliloquy_after_html_meta_table do_action( ‘soliloquy_after_html_meta_table’, $id, $data, $post_id )
/includes/admin/settings.php
soliloquy_settings_styles do_action( ‘soliloquy_settings_styles’ )
soliloquy_settings_scripts do_action( ‘soliloquy_settings_scripts’ )
soliloquy_tab_settings_ do_action( ‘soliloquy_tab_settings_’ . $id )
soliloquy_settings_general_box do_action( ‘soliloquy_settings_general_box’ )
/includes/global/common.php
soliloquy_flush_caches do_action( ‘soliloquy_flush_caches’, $post_id, $slug )
/includes/global/shortcode.php
soliloquy_before_output do_action( ‘soliloquy_before_output’, $data )
soliloquy_api_start_global do_action( ‘soliloquy_api_start_global’, $data )
soliloquy_api_start do_action( ‘soliloquy_api_start’, $data )
soliloquy_api_preload do_action( ‘soliloquy_api_preload’, $data )
soliloquy_api_config_start do_action( ‘soliloquy_api_config_start’, $data )
soliloquy_api_config_callback do_action( ‘soliloquy_api_config_callback’, $data )
soliloquy_api_on_load do_action( ‘soliloquy_api_on_load’, $data )
soliloquy_api_before_transition do_action( ‘soliloquy_api_before_transition’, $data )
soliloquy_api_after_transition do_action( ‘soliloquy_api_after_transition’, $data )
soliloquy_api_config_end do_action( ‘soliloquy_api_config_end’, $data )
soliloquy_api_slider do_action( ‘soliloquy_api_slider’, $data )
soliloquy_api_end do_action( ‘soliloquy_api_end’, $data )
soliloquy_api_end_global do_action( ‘soliloquy_api_end_global’, $data )
/includes/global/widget.php
soliloquy_widget_before_output do_action( ‘soliloquy_widget_before_output’, $args, $instance )
soliloquy_widget_before_title do_action( ‘soliloquy_widget_before_title’, $args, $instance )
soliloquy_widget_before_slider do_action( ‘soliloquy_widget_before_slider’, $args, $instance )
soliloquy_widget_after_slider do_action( ‘soliloquy_widget_after_slider’, $args, $instance )
soliloquy_widget_after_output do_action( ‘soliloquy_widget_after_output’, $args, $instance )
soliloquy_widget_before_form do_action( ‘soliloquy_widget_before_form’, $instance )
soliloquy_widget_middle_form do_action( ‘soliloquy_widget_middle_form’, $instance )
soliloquy_widget_after_form do_action( ‘soliloquy_widget_after_form’, $instance )
/soliloquy.php
soliloquy_pre_init do_action( ‘soliloquy_pre_init’ )
soliloquy_init do_action( ‘soliloquy_init’ )
soliloquy_updater do_action( ‘soliloquy_updater’, $key )
[i]
[i]