This plugin can display a photos gallery based on albums from Google Photos. This way you don't need to care about images resizing, compression, thumbnails storage or server bandwith for large galleries.
Features
- Uses OAuth authentication to access private albums
- Customizable thumbnail sizes
- Also provides page snippets to embed an album in a static page
- Optional caching of API requests
- No CSS or JS out of the box, it's up to you to style or override the default layout
Installation
Prerequisites
This plugin comes with an OAuth client application that will only work on
localhostto allow you to test the plugin. Before deploying it on any hostname other thanlocalhost, you must create your own OAuth app credentials or use existing credentials for the hostname in question (i.e.example.com).
Follow these steps to get your credentials: Google documentation. The documentation will say that "the Authorized redirect URI does not require a value", but it is required for this use case. You will need to set the Authorized redirect URI to https://example.com/backend/inetis/googlephotos/oauth/callback, replacing example.com/backend with your domain name and backend URL.
When done, you will be given a Client ID and a Client Secret, which you will need to provide to the plugin by overriding the configuration file. See the official documentation on doing this. Basically, just copy the file /plugins/inetis/googlephotos/config/config.php to /config/inetis/googlephotos/config.php and put your app credentials inside.
Finally, you need to enable enable the Photos Library API for your project.
Configure the component
From the settings page of the plugin, login to your Google account. If you get a 404 error when clicking on the "Sign in" link, you have missed something while setting up your OAuth app.
In the settings, you can also define a cache duration. Cache is used on requests to the Google API to retrieve informations about the albums. The images are not cached, only their urls are.
By default, Google Photos shows all albums related to your Google account or Google+ profile including automatically generated ones like "Auto Backup" and "Profile Photos". You can hide these albums from the plugin settings by adding as many albums as you want to the "Hidden albums" section. Just click on "Add new item" and fill the field with either an album ID or an album name. The names of these album may change depending on the language of your Google account, so it is advised to use the album id instead of the name.
Pages setup
You need to create two CMS pages:
One to display the albums of a single gallery
For this one you need an additional :albumId routing parameter in the URL of the page.
Add the Google Photos album component and in the component settings set the Album ID property to the name of the routing parameter you setup for this page (i.e. :albumID).
One to display all galleries
Add the Google Photos albums list component to this page, setting the Album Page parameter to the page you created for the albums of a single gallery.
Support
Please use GitHub Issues to report any issues with this plugin.
Reviews should not be used for getting support or reporting bugs, if you need support please use the Plugin support link.
Components / Snippets properties
The plugin comes with 2 components, also available as page snippets, used to display the galleries. Here are described the properties of these component:
| Property | Components | Description |
|---|---|---|
| Album ID | Single album | Determine what album to display. In a component usage, it's typically extracted from an url parameter. When used as a snippet, a dropdown listing all albums on the account is shown. |
| Album Page | Albums list | Determine which CMS page should be used to display a single album. |
| Visibility | Both | Determine the visibility level of the albums to show. See API doc for possible values |
| Thumbnail size | Both | This is used with Crop mode to compute to generate thumbnails. |
| Crop mode | Both | To which dimension of each image should apply the Thumbnail size property. There is no documented way to do it in the API, so the plugin is using this method instead |
| Square crop thumbnails | Both | If true, generated thumbnails will have a 1:1 ratio. If false, images will be resized according to the Thumbnail size, but the original ratio will be preserved. |
Accessible parameters
When overriding the component views, the following properties are available from Twig:
In the GooglePhotosAlbum component:
| Property | Description |
|---|---|
| images | An array of images contained inside the album (see table below for details). |
| albumTitle | The actual name of the album being displayed. |
Each entry of the images array contains the following properties:
| Property | Description |
|---|---|
| photoTitle | The title of the photo given by the user. |
| photoUrl | The url of the photo in original size. In the case of a video, this is the url of the best resolution stream |
| thumbUrl | The url of the generated thumbnail for the photo. |
| photoSummary | A description of the image given by the user. |
| photoPublished | The date when the photo was initially published. |
| photoUpdated | The last modification date of the photo. |
| imageHeight | The height in px of the original image. |
| imageWidth | The width in px of the original image. |
| type | The element type, can be photo or video. |
| streams | Only available if type is video: an array of stream objects (see table below for details) |
Each entry of the streams array (for videos) contains the following properties:
| Property | Description |
|---|---|
| url | The url of the video stream |
| height | The height in px of the target |
| width | The width in px of the target |
| contentType | The MIME type of the target |
In the GooglePhotosAlbums component:
| Property | Description |
|---|---|
| albums | An array of albums from the account (see table below for details). |
Each entry of the albums array contains the following properties:
| Property | Description |
|---|---|
| albumId | The unique id of the album. |
| albumTitle | The name of the album given by the user. |
| photoUrl | The url of the photo to use as album cover in original size. |
| thumbUrl | The url of the generated thumbnail for the album cover image. |
| albumNumPhotos | The total amount of images inside the album. |
| type | The element type, will always be album |
-
Anton Antonov
Found the plugin useful on 11 Nov, 2021
October CMS 1.1.9
Default: 'backendUri' => 'backend' Plugin not work!
When: 'backendUri' => '/backend' Plugin work.
-
Yan Morand
Found the plugin useful on 9 Aug, 2017
Nice plugin and nice documentation, thanks!
-
| 1.5.1 |
Fix errors when an empty album exists on the account Jul 29, 2024 |
|---|---|
| 1.5.0 |
Add 'inetis.googlephotos.access_settings' permission Oct 18, 2023 |
| 1.4.0 |
Add October v3 compatibility Aug 09, 2023 |
| 1.3.0 |
!!! Update to Google Photos API. Read the upgrade guide on the market Feb 08, 2019 |
| 1.2.3 |
Use deprecation extension for the api Jan 18, 2019 |
| 1.2.2 |
Fix an error on the single album snippet Jan 18, 2018 |
| 1.2.1 |
Fix an error on albums list when caching is enabled Oct 09, 2017 |
| 1.2.0 |
Add support for videos Oct 09, 2017 |
| 1.1.1 |
Fix single album snippet generating an error on 32bits php Sep 12, 2017 |
| 1.1.0 |
!!! Rename plugin into GooglePhotos Aug 08, 2017 |
| 1.0.1 |
First version of googleimages Aug 08, 2017 |
Updating to 1.3.0
Version 1.3.0 is now using the GooglePhotos api instead of the PicasaWebData api.
There are some required changes to make for the plugin to work:
- You need to add the Photos Library API to your Google Cloud Platform project
- You need to sign out and sign in again in the plugin settings in order to authorize the new API to access your account.
There are a few changes that you should care about:
- Album ids have changed. If you are using the
googlePhotosAlbumcomponent with a particular album, you need to select it again after updating - If you have set some excluded albums by id, you should also change them
- The size definition for the thumbnails has changed. After updating the plugin, you will need to go trough everywhere you use the components to update the sizes
- It is not possible anymore to filter by albums visibility
- The photos urls returned by the API are now valid for 60 minutes only. Check that the cache duration in the plugin settings is not longer that 60 minutes.
- The name of some variables have changed in the API (such as the
photoTitlenow calledfilename) but the old equivalent are still available for backward compatibility. - The
streamsarray for videos no longer exists (it was not used in the default partial). Useurl(orphotoUrl) instead to get the video source.
If you have code based on Inetis\GooglePhotos\PicasaWebData\PicasaClient, there are some changes that you need to make:
Inetis\GooglePhotos\PicasaWebData\PicasaClienthave been removed, useInetis\GooglePhotos\PicasaWebData\GooglePhotosClientinstead.- The second parameter (
$albumTitle) of thegetAlbumImages()method have been removed, use the newgetAlbum()method to get this information.