Envira Gallery Documentation

Documentation, Reference Materials and Tutorials for Envira Gallery

Downloads Addon

Want to allow your users to download images from your galleries? You can with our Downloads Addon! This doc will show you how to set up a downloading for each gallery image, allowing visitors to download your images.


Please follow our instructions on how to install and activate addons.

In this instance, you’ll be activating the Envira Downloads Addon.

Choose the gallery you wish to edit, and under the Downloads tab, you’ll be able to configure the following options:

  • Display Download Button?Enables or disables displaying the download button on each image in the gallery view.
  • Image Size to DownloadChoose the image size your visitors will download by clicking the single download icon on an image or if selecting ‘download all’ link.
  • Display Download All Button?Check this option to provide a ‘download all’ link that will place all files in a zip folder for the visitor to download all images with 1 click.
  • Custom name the zip file?Type in the name of the .zip file (example: my-downloads)
  • Download All Button PositionWhere to display the download all link. Above the gallery or below.
  • Download All Button LabelEnter the text that will be used to display the download all link. (example: Download All Images)
  • Download Button PositionWhere to display the download button over the image. Available options are Top Left, Top Right, Bottom Left, Bottom Right.
  • Force Download?If enabled, prompts a file download in the browser instead of display the image in a new browser window/tab.

  • Display Download Button?Enables or disables displaying the download button on each image in the Lightbox view.
  • Download Button PositionWhere to display the download button over the image. Available options are Top Left, Top Right, Bottom Left, Bottom Right. This will only be shown to choose as long as the Lightbox theme is not Base (Dark) or Base (Light). Dark/Light lightbox themes automatically place the icon in the top right corner of the lightbox.
  • Force Download?If enabled, prompts a file download in the browser instead of display the image in a new browser window/tab.

The Downloads Tab options in the gallery edit screen.

If you’ve configured the Download button to appear in the gallery view, hover over a gallery image to see it appear:

The Download Button will appear over the gallery images on hover.

If you’ve enabled the Download button to appear in the Lightbox view, you’ll see it display in the position configured when opening the image in Lightbox view:

You can enable the Download Button in lightbox view for your galleries too.

Selecting the Download Button will open the image in a new window/tab where it can then be saved. Or if you prefer, you can enable the Force Download? option, which prompts a file download in the browser instead of displaying the image in a new browser window/tab.


If you’re using the Albums Addon, you can also configure the following options in the album edit screen’s Downloads tab:

  • Display Download Button?Enables or disables displaying the download button on each image in the Lightbox view.
  • Download Button PositionWhere to display the download button over the image. Available options are Top Left, Top Right, Bottom Left, Bottom Right.
  • Force Download?If enabled, prompts a file download in the browser instead of display the image in a new browser window/tab.

The Downloads tab options in the Album edit screen.


A: Unfortunately, the Enivra Downloads Addon is incompatible with images served using a CDN. In order to use the Downloads Addon, all images will have to be stored in the default WordPress Media Library.


A: This can happen for several different reasons:

  1. Server timeout – if there are a lot of hi-res images in your gallery it could be that the gallery is just too large for the server to handle zipping up all the images and times out in the process. The max execution time for php processing and server timeouts are set at through the hosting company. We recommend you reach out to them and ask them to increase your timeout and max execution time settings. It may be a good idea as well to ask them to check the Zip library on the server to make sure it doesn’t need re-installing.
  2. Image or images in the gallery are corrupt – if any image in the gallery is missing or corrupted, this will affect the entire download process.
  3. Server errors – you may want to reach out to our support team and ask them to further debug this issue for you.

This table describes the available configuration options for your Envira Galleries and Albums when using this Addon.

The Programmatic Name and Programmatic Values columns are used when configuring the Dynamic Addon’s shortcode or template tag, or when overriding the default settings for creating a new Gallery or Album.

Downloads Tab

You will see the following new options in the Downloads tab for Galleries.

Config Item Description Options Programmatic Name Programmatic Values
GALLERY OPTIONS
Display Download Button? Enables or disables displaying a download button on each image in the gallery view Enabled/Disabled download 0,1
Image Size To Download Select the size of the images that will be downloaded Dropdown download_image_size
Display Download All Button? Enables or disables the link to download all images in gallery Enabled/Disabled download_all 0,1
Custom name the zip file Set your download .zip file name string download_custom_name
Download All Button Position Choose to display Above or below gallery Dropdown download_all_position Above, Below
Download All Button Label Set your text for the download all link string download_all_label
Download Button Position Where to display the download button over the image. Top Left, Top Right, Bottom Left, Bottom Right download_position top-left,top-right,bottom-left,bottom-right
Force Download? If enabled, prompts a file download in the browser instead of display the image in a new browser window/tab. Enabled/Disabled download_force 0,1
Download Password Requires the Password Protection Addon. If defined, requires the visitor to enter this password when they attempt to download an image.  Once a valid password is entered, the user won’t be prompted to enter their password again. string download_password string
Invalid Password Message Requires the Password Protection Addon. The message to display if the visitor enters an incorrect password. string download_invalid_password_message string
LIGHTBOX OPTIONS
Display Download Button? Enables or disables displaying a download button on each image in the lightbox view Enabled/Disabled download_lightbox 0,1
Download Button Position Where to display the download button over the image. Top Left, Top Right, Bottom Left, Bottom Right download_lightbox_position top-left,top-right,bottom-left,bottom-right
Force Download? If enabled, prompts a file download in the browser instead of display the image in a new browser window/tab. Enabled/Disabled download_lightbox_force 0,1

You will see the following new options in the Downloads tab for Albums (available for the Albums Addon, and specify the lightbox download options for each Gallery loaded in the Lightbox view from an Album).

Config Item Description Options Programmatic Name Programmatic Values
LIGHTBOX OPTIONS
Display Download Button? Enables or disables displaying a download button on each image in the lightbox view Enabled/Disabled download_lightbox 0,1
Download Button Position Where to display the download button over the image. Top Left, Top Right, Bottom Left, Bottom Right download_lightbox_position top-left,top-right,bottom-left,bottom-right
Force Download? If enabled, prompts a file download in the browser instead of display the image in a new browser window/tab. Enabled/Disabled download_lightbox_force 0,1

Changelog

1.1.0 (10-18-2017)

  • Fix: Minor bug fixes

1.1.1 (06-27-2017)

  • Fix: Download icon in lightbox with display:none inline styling now resolved.
  • Fix: Downloads button should show after AJAX loads new page.

1.0.9 (02-01-2017)

  • Fix: Draft images contained in downloads

1.0.8 (2016-12-08)

  • Added: Select image size for download
  • Fix: Force downloads for instagram
  • Fix: cases where download is 0kb

1.0.7 (2016-11-03)

  • Fix: Download links open in new windows.
  • Fix: Various minor bug fixes.

1.0.6 (2016-10-04)

  • Fix: Resolving compatibility issues with dynamic addon.

1.0.5 (2016-09-22)

  • Fix: Password protected downloads should ask for passwords properly, and not allow downloads w/o correct passwords.

1.0.4 (2016-09-01)

  • Fix: Safari downloads all images as regular zips and not EXE files.

1.0.3 (2016-08-25)

  • Fix: Now functional when "Render all WordPress Galleries using Envira" option is enabled.

1.0.2 (2016-07-26)

  • Fix: Download button position setting now properly saves.

1.0.1 (2016-05-31)

  • Add an option to the Downloads Addon allowing users to download an entire Gallery as a ZIP file.

1.0.0 (2016-05-05)

  • Initial release of the addon.
[i]
[i]
[i]
[i]