Kirby Instagram Feed
Instagram feed on your website for Kirby 3.
Instagram API
This plugin powered by the
new Instagram Basic Display API.
Rate Limits
There is an Instagram API
request
limit (Instagram API rate limits)
. Don’t worry! The plugin caches it periodically for the time
you set from config.
Expire Token
Instagram access token expires after 2 months (60 days) by default. The plugin automatically refresh the token. If cache
is enabled the plugin will do it 1 week before, otherwise it will do it on every request and this is not recommended. So
you don’t need to do anything.
Installation
- Download the latest release
- Unzip downloaded file
- Copy/paste unzipped folder in your
/site/pluginsfolder
Usage
You can use sample basic snippet of plugin:
<?php snippet('instagram-feed') ?>
If you want to customize it, you can look the example usage below:
<?php foreach (site()->instagramFeed() as $feed): ?>
<a href="<?= $feed->permalink() ?>" target="_blank">
<img title="<?= $feed->caption() ?>" src="<?= $feed->media_url() ?>">
</a>
<?php endforeach ?>
Available $feed methods
- $feed->id()
- $feed->caption()
- $feed->is_album()
- $feed->is_image()
- $feed->is_video()
- $feed->media() (Only available with
storeenabled option) - $feed->media_type() (The Media’s type. Can be
IMAGE,VIDEOorCAROUSEL_ALBUM) - $feed->media_url()
- $feed->permalink()
- $feed->thumbnail() (Only available with
storeenabled option) - $feed->thumbnail_url()
- $feed->timestamp()
- $feed->username()
- $feed->children() (Only available for the
CAROUSEL_ALBUMmedia type)
Also site()->instagramFeed() and all items ($feed) in it are collection objects and have all collection methods.
Showing album feeds
If the feed item is an album media type, it does not have a media element/url. Album media type is a collection of multiple media. For this you should call the $feed->children() method. This method returns a media collection. Here is an example of usage:
<?php if ($feed->is_album() === true && $children = $feed->children()): ?>
<?php foreach ($children as $child): ?>
<?php if ($child->is_image() === true): ?>
<a href="<?= $child->permalink() ?>" target="_blank">
<img title="<?= $child->caption() ?>" src="<?= $child->media_url() ?>">
</a>
<?php elseif ($child->is_video() === true): ?>
<a href="<?= $child->permalink() ?>" target="_blank">
<video width="100%" height="100%" autoplay preload muted loop>
<source src="<?= $child->media_url() ?>" type="video/mp4">
</video>
</a>
<?php endif ?>
<?php endforeach ?>
<?php endif ?>
Options
The default values of the package are:
| Option | Type | Default | Description |
|---|---|---|---|
| accessToken | string | null | Access token for Instagram Basic Display API. |
| cache | boolean | true | Enable/disable caching feed and refresh token request. Highly recommended that the cache be enabled to avoid exceeding api request limit. |
| store | boolean | false | Enable/disable storing images or videos for this plugin. |
| debug | boolean | false | Enable/disable debugging for this plugin. |
| expire | int | 1440 | Sets how long the feed items are cached as minutes. Default is one day. |
| limit | int | 20 | Sets how many feed items are fetch from API. |
All the values can be updated in the config.php file and prefixed with owebstudio.instagram-feed.
Sample options
<?php
// /site/config/config.php
return [
'owebstudio.instagram-feed' => [
'accessToken' => 'INSTAGRAM_ACCESS_TOKEN',
'cache' => true,
'store' => true,
'debug' => false,
'expire' => 180, // 3 hours
'limit' => 10 // fetch limit
]
];
Resources
Here are a few resources on Instagram access token creation:
Enhancements