readme.txt

=== WP Instagram Widget ===
Contributors: scottsweb, codeforthepeople
Tags: instagram, widget, photos, photography, hipster, sidebar, widgets, simple
Requires at least: 3.0
Tested up to: 4.2.2
Stable tag: trunk
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

WP Instagram widget is a no fuss WordPress widget to showcase your latest Instagram pics.

== Description ==

WP Instagram widget is a no fuss WordPress widget to showcase your latest Instagram pics. It does not require you to provide your login details or sign in via oAuth.

The widget is built with the following philosophy:

* Use sensible and simple markup
* Provide no styles/css - it is up to you to style the widget to your theme and taste
* Cache where possible - filters are provided to adjust cache timings
* Require little setup - avoid oAuth for example

[a plugin by Scott Evans](http://scott.ee/ "WordPress designer and developer")

== Installation ==

To install this plugin:

1. Upload the `wp-instagram-widget` folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. That's it!

To use within the [null theme framework](https://github.com/scottsweb/null) or [null child theme](https://github.com/scottsweb/null-child)

1. Drop the wp-instagram-widget.php file into your /assets/inc/widgets/ folder
1. Activate via 'Appearance' -> 'Theme Options' menu, under the 'WordPress' tab

== Frequently Asked Questions ==

= Hooks & Filters =

The plugin has five filters. The first allows you adjust that cache time for retrieving the images from Instagram:

`add_filter('null_instagram_cache_time', 'my_cache_time');

function my_cache_time() {
	return HOUR_IN_SECONDS;
}
`

The second allows you to filter video results from the widget:

`add_filter('wpiw_images_only', '__return_true');`

The rest allow you to add custom classes to each list item, link or image:

`add_filter( 'wpiw_item_class', 'my_instagram_class' );
add_filter( 'wpiw_a_class', 'my_instagram_class' );
add_filter( 'wpiw_img_class', 'my_instagram_class' );

function my_instagram_class( $classes ) {
	$classes = "instagram-image";
	return $classes;
}
`

In version 1.3 you also have two new hooks for adding custom output before and after the widget:

`wpiw_before_widget`
`wpiw_after_widget`

In version 1.4 and above you can also customise the image loop completely by creating a `parts/wp-instagram-widget.php` file in your theme.

== Screenshots ==

1. Instagram widget on the front end
2. Instagram widget in the theme customiser

== Changelog ==

= 1.4.1 (in progress) =
* Remove null framework support
* Update plugin header

= 1.4 =
* Introduce class filters
* Only set a transient if images are returned
* Optional template part for complete output control

= 1.3.1 =
* Force lowercase usernames
* Correct hook name

= 1.3 =
* Option to open links in new window
* Support for video items (with filter to disable this)
* New actions for adding custom output to the widget
* Support for https://
* Correctly escape attributes

= 1.2.1 =
* Change transient name due to data change

= 1.2 =
* Better error handling
* Encode emoji as they cause transient issues

= 1.1 =
* Fix issue with Instagram feed
* Add composer.json

= 1.0 =
* Initial release