forked from scottsweb/wp-instagram-widget
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
executable file
·175 lines (124 loc) · 5.28 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
=== WP Instagram Widget ===
Contributors: scottsweb, codeforthepeople
Tags: instagram, widget, photos, photography, hipster, sidebar, widgets, simple
Requires at least: 4.4
Tested up to: 4.8.2
Stable tag: 2.0.0
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!
Alternatively you can search for the plugin from your WordPress dashboard and install from there.
== 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 the [ul] list container, each list item, link or image:
`add_filter( 'wpiw_list_class', 'my_instagram_class' );
add_filter( 'wpiw_item_class', 'my_instagram_class' );
add_filter( 'wpiw_a_class', 'my_instagram_class' );
add_filter( 'wpiw_img_class', 'my_instagram_class' );
add_filter( 'wpiw_linka_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.
In version 1.9.6 you can now use a filter to change the location of your custom template part: `wpiw_template_part`.
== Screenshots ==
1. Instagram widget on the front end
2. Instagram widget in the theme customiser
== Changelog ==
= 2.0.0 =
* Ability to track tags / hashtags instead of just usernames (e.g. #cheese)
* New filter for custom link class
* Bundle German language (props jensteichert)
* Other minor fixes and formatting
= 1.9.8 =
* Return more items when using filter for images only
= 1.9.7 =
* Fix double trailing slash on custom text link
= 1.9.6 =
* Trailing slash all URLs to support Instagram app on iOS
* Support selective refresh in 4.5
* New filter for `wpiw_template_part`
= 1.9.5 =
* Another fix for image URL handling, I think we have all the edge cases now!
= 1.9.4 =
* IMPORTANT: You must be on WordPress 4.4 or later to upgrade to this version of the plugin. This fixes a bug with PHP versions < 5.4.7. If you are on a version of WordPress older than 4.4 and you notice images are not loading then I recommend rolling your version of the widget back to this version: https://github.com/scottsweb/wp-instagram-widget/blob/c66550eded59bd51f508f304a85a3e031ac4044c/wp-instagram-widget.php
= 1.9.3 =
* Fix issues introduced in the last version (apologies). Certain CDN URLs are still in use
= 1.9.2 =
* Better handling of all image and video image URLs props @thegallagher
= 1.9.1 =
* Fix bug with some image URLs
= 1.9 =
* WordPress.com VIP checked
* Updated CDN matching to ensure correct image sizes are served at all times
* Shortened the transient key - should mean we bump into the character limit less often
* Remove use of `extract`
= 1.8.1 =
* Apologies for all the recent updates, all good things though!
* Update plugin text domain ready for translate.wordpress.org
* Introduce an 'original' image size if you want to use non-square originals
* Introduce new filter for `<ul>` class `wpiw_list_class`
= 1.8 =
* Bring back image captions
* Fix small PHP error in 1.7
= 1.7 =
* Bring back image sizes
* Use thumbnails that are square (originals are in the data returned and can be used)
* Remove @ from usernames
= 1.6 =
* Compatibility with 4.3
= 1.5.1 =
* Invalidate old transients
= 1.5 =
* Remove null framework support
* Fix breaking change by Instagram whilst maintaining old style support
* Remove thumbnail size option
= 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