Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

Latest commit

 

History

History
executable file
·
74 lines (50 loc) · 4.54 KB

README.md

File metadata and controls

executable file
·
74 lines (50 loc) · 4.54 KB
‼️ This repository is no longer actively maintained. The plugin still works, but does not receive any further updates other than community contributed fixes.

Image username feed

WordPress plugin to get Instagram username feeds working again by bypassing the API. Handcafted with love at Digitoimisto Dude Oy, a Finnish boutique digital agency in the center of Jyväskylä.

The Instagram fetcher is based on Instagram-Hashtag-Grabber from Thomas Bolander and settings page is made with excellent Simple Admin Pages library made by Nate Wright.

Table of contents

  1. Please note before using
  2. License
    1. Legal
  3. Usage
    1. Settings
    2. Functions
    3. Hooks
  4. Composer
  5. Contributing

Please note before using

Image username feed plugin is not meant to be "plugin for everyone", it needs at least some basic knowledge about php and css to add it to your site and making it look beautiful.

This is a plugin in development for now, so it may update very often because new features and changes in Instagram's end. By using this plugin, you agree that the anything can change to a different direction without a warning.

Legal

Please be aware that Instagram prohibits crawling, scraping and caching in their TOC. This plugin uses same endpoint that Instagram is using in their own site, so it's arguable if TOC can prohibit the use of openly available information.

There has been few court cases in United States, where the court has ruled that scraping is illegal. In Europe, there have been also few similar cases. None of these cases have had Instagram involved.

This being said, use your own consideration whether you wan't to use this plugin.

License

Image username feed is released under the GNU GPL 2 or later.

Usage

Settings

Settings page can be found from Settings -> Image username feed.

From settings page you can set which username to use and check when the last fetch from Instagram was made. Username can be also set dynamically from functions described below.

Functions

Plugin brings few functions to use in your site.

get_the_dude_img_userfeed_raw

Returns array of objects received from Instagram. Object contains all basic details about the image; timestamp, comment and like counts, caption, author information and src to use when displaying image. These can be changed with filter.

get_the_dude_img_userfeed_thumbnails

Returns string containing all images in html img -tag, <img src='thumbnail_src' alt='caption' />.

the_dude_img_userfeed_thumbnails

Displays all images in html img -tag, <img src='thumbnail_src' alt='caption' />.

Hooks

There are few filters where you can hook and change functionality of plugin.

dude_img_userfeed_insta_count

Change amount of images to fetch and store. Default value is 10.

Usage is simple; add add_filter( 'dude_img_userfeed_insta_count', function() { return 2; } ); to your theme functions.php file.

dude_img_userfeed_insta_count_{$username}

Change amount of images to fetch and store by username. Defaults to dude_img_userfeed_insta_count value.

dude_img_userfeed_insta_transient_lifetime

Images are stored to transient in favor of caching and reducing page load time. By default, lifetime is five minutes and after that new images are fetched from Instagram when calling one of previously listed functions.

Use WordPress transient expiration syntax.

Composer

To use with composer, run composer require digitoimistodude/image-user-feed dev-master in your project directory or add "digitoimistodude/image-user-feed":"dev-master" to your composer.json require.

Contributing

If you have ideas about the theme or spot an issue, please let us know. Before contributing ideas or reporting an issue about "missing" features or things regarding to the nature of that matter, please read Please note section. Thank you very much.