owebstudio / kirby-instagram-feed

1.5.0 2026-10-30 18:49 UTC

Requires

• php: ^8.2
• getkirby/composer-installer: ^1.2

Requires (Dev)

• owebstudio/kirby-license: ^1.0

Conflicts

• getkirby/cms: <5.0

proprietary

• oweb studio

• instagram
• kirby
• kirby-plugin
• kirby5-plugin
• kirby-5
• owebstudio
• owebstudio-plugin
• kirby-instagram
• instagram-feed

Published on Packagist.org on 2026-10-30 18:56 UTC

README

Kirby Instagram Feed

Instagram feed on your website for Kirby 5 (PHP 8.2 to 8.5). For Kirby 3 and 4, use version 1.4.0.

⚠️ Client must have a business professional/creator account for this to work

Instagram API

This plugin powered by the new Instagram 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.

If Kirby's pages cache is active, pages that show the feed are cached until the feed expires, so they always show a fresh feed.

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. On a live site this needs a license key (see License).

Installation

1. Download the latest release
2. Unzip downloaded file
3. Copy/paste unzipped folder in your /site/plugins folder

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): ?>
    <?php if ($src = $feed->media_url()): ?>
        <a href="<?= esc($feed->permalink() ?? '') ?>" target="_blank">
            <img title="<?= esc($feed->caption() ?? '') ?>" src="<?= esc($src) ?>">
        </a>
    <?php endif ?>
<?php endforeach ?>

Available $feed methods

• $feed->id()
• $feed->caption()
• $feed->is_album()
• $feed->is_image()
• $feed->is_video()
• $feed->media() (Only available with store enabled option)
• $feed->media_type() (The Media's type. Can be IMAGE, VIDEO or CAROUSEL_ALBUM)
• $feed->media_url() (Can be null. Instagram omits it for albums without a cover and for media flagged for a copyright violation, so always check it before rendering)
• $feed->permalink()
• $feed->thumbnail() (Only available with store enabled option)
• $feed->thumbnail_url()
• $feed->timestamp()
• $feed->username()
• $feed->children() (Only available for the CAROUSEL_ALBUM media type)

Also site()->instagramFeed() and all items ($feed) in it are collection objects and have all collection methods.

The values come from Instagram, so escape them in your HTML, e.g. with esc($value).

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 && $src = $child->media_url()): ?>
            <a href="<?= esc($child->permalink() ?? '') ?>" target="_blank">
                <img title="<?= esc($child->caption() ?? '') ?>" src="<?= esc($src) ?>">
            </a>
        <?php elseif ($child->is_video() === true && $src = $child->media_url()): ?>
            <a href="<?= esc($child->permalink() ?? '') ?>" target="_blank">
                <video width="100%" height="100%" autoplay preload muted loop>
                    <source src="<?= esc($src) ?>" 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 
    ]
];

Creating Instagram token

Follow the steps below to create a new Instagram token. Remember, client must have a business professional/creator account for this to work

1. Login to https://developers.facebook.com/
2. Create a new App
3. Make an App name
4. Choose "Other" for use case
5. Choose "Business" for app type
6. Confirm "Create App"
7. Add Instagram product to your App
8. Add client Instagram account to the Instagram API
9. Generate a new token
10. Add this token to the site/config.php or other config environment file
11. Delete media folder and site/cache

License

Instagram Feed is a commercial plugin. It is free to use on your local computer and on staging sites. A live site needs a license key: buy one and activate it in the Panel's System view (Kirby 5 and newer) by clicking the license status of the plugin.

Without a license key, the plugin does not renew the Instagram access token on a live site. The feed keeps working until the token expires (60 days after it was created or last renewed). After that, the snippet renders nothing.

oweb studio Commercial License. Versions released under the MIT license stay MIT. The current license is available at https://github.com/owebstudio/.github/blob/main/LICENSE.md.