Skip to content

Wordpress plugin to open images on your site in Lightbox/Fancybox. Focused on theme developers and speed.

Notifications You must be signed in to change notification settings

jakub-klapka/image-lightbox-wp-plugin

Repository files navigation

Lumiart's Dev Friendly Lightboxed Images

This plugin offers another way, how to insert images into your posts, which opens in lightbox. It's focused primarily on theme developers (thus tons of configuration via filters) and speed.

What does it do?

Lightbox checkbox preview

  • New Lightbox checkbox in Add Media dialog to insert image opened in lightbox.
  • Supports also WP-generated galleries ([gallery])
  • Based on great Fancybox library by Jānis Skarnelis
  • Frontend files are loaded only, when they are necessary (no more thousand-script headers on frontend)
  • Also various PHP files are loaded only when they are needed (to save server memory)
  • Plugin is very simple but still highly configurable via filters (no settings in DB - perfect for theme devs)

Filters

###lumi-image-fancybox/enable_gallery

Default: true

Enabling lightbox effect on [gallery] shortcode. This setting is site-wide and can't be changed for specific galleries.


###lumi-image-fancybox/upload_checkbox_default

Default: true

Controls, if the "lightbox" checkbox in Add Media will be checked by default.


###lumi-image-fancybox/full_image_size

Default: full

This WP-image-size will be used as lightbox target for images. By default, it will target full sized images - so I recommend using Imsanity. Or just change filter to large.


###lumi-image-fancybox/upload_dialog_lightbox_title

Default: __('Lightbox')

Text as title in front of checkbox in Add Media dialog. I recommend wrapping text in i18n function, to keep it translatable. For example:

add_filter( 'lumi-image-fancybox/upload_dialog_lightbox_title', function() {
    return __( 'My customized title', 'My textdomain' );
} );

###lumi-image-fancybox/upload_dialog_help_message

Default: __( 'If checked, click on image will open it in overlay window. Don't forget to set size and alignment below.' )

Same as above for helper text below checkbox.


###lumi-image-fancybox/jquery_library

Default: jquery

Lightbox effect is depending on jQuery library. But if you have jquery included in some other script (maybe you Grunting frontend scripts?), you can pass your script handle into this filter and plugin will assume, that jquery is loaded with specified script and won't initiate loading of separate jquery library.


###lumi-image-fancybox/fancybox_js_config

Default: false

If you want to modify Lightbox behavior on frontend, you can pass array of parameter to this filter. You can find all available parameters on Fancybox site. For example:

add_filter( 'lumi-image-fancybox/fancybox_js_config', function() {
    return array(
        'padding'   => array( 20, 10, 20, 20 ),
        'fitToView' => false
    );
} );

Notes

  • Plugin won't affect existing single images in pages and posts, but It will affect all galleries if you leave plugins gallery feature enabled!
  • If your theme or another plugin completely rewrite [gallery] output via post_gallery filter, this plugin won't work for galleries. Using use_default_gallery_style and gallery_style filters to change styles should be safe though.

About

Wordpress plugin to open images on your site in Lightbox/Fancybox. Focused on theme developers and speed.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published