forked from kylephillips/favorites
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
292 lines (200 loc) · 18.5 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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
=== Favorites ===
Contributors: kylephillips
Donate link: http://favoriteposts.com/
Tags: favorites, like, bookmark, favorite, likes, bookmarks, favourite, favourites, multisite, wishlist, wish list
Requires at least: 3.8
Requires PHP: 5.4
Tested up to: 6.1
Stable tag: 2.3.2
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Favorites for any post type. Easily add favoriting/liking, wishlists, or any other similar functionality using the developer-friendly API.
== Description ==
**Why Favorites?**
Favorites is designed for end users and theme developers. It provides an easy-to-use API for adding favorite button functionality to any post type.
The plugin can provide a way to save favorites, likes, bookmarks, or any other similar types of data with its customizable button text.
Visit [favoriteposts.com](http://favoriteposts.com) for a full list of available template functions and shortcodes.
**Features**
**Use with Any Post Type** - Enable or disable favorite functionality per post type while automatically adding a favorite button before and/or after the content. Or, use the included functions to display the button anywhere in your template.
**Available for All Users** – Don't want to hide functionality behind a login? Favorites includes an option to save anonymous users' favorites by either Session or Cookie. Logged-In users' favorites are also saved as user meta
**Designed for Developers** - Favorites works great out-of-the-box for beginners, but a full set of template functions unlocks just about any sort of custom functionality developers may need. Favorites outputs the minimum amount of markup needed, putting the style and control in your hands.
**GDPR**
As of version 2.2, a setting is provided to help comply with GDPR standards. To enable this setting, visit Settings > Favorites > Users, and check the field under "User Cookie Consent." When this setting is enabled, the content saved under the setting displays in a modal window, and the user must agree to the terms you provide before favorite cookies can be saved. Note: There is no language provided by default. This should be supplied by a qualified attorney or legal entity. Once the user has approved or denied cookies, that is saved in the "simplefavorites" cookie along with the timestamp of approval or denial. If the site is part of a multi-site installation, the setting will carry through to all sites.
If your site already has a cookie compliance solution in place, there are two document-level jQuery events that may be triggered in order to approve or deny cookies in the background.
To approve the use of cookies, trigger the event "favorites-user-consent-approved". To deny the use of cookies, trigger the event "favorites-user-consent-denied".
**Multisite Compatible** - As of version 1.1.0, Favorites is multisite compatible. User favorites are saved on a site/blog basis, and may be retrieved and displayed across sites.
For more information visit [favoriteposts.com](http://favoriteposts.com).
**Important: Favorites requires WordPress version 3.8 or higher, and PHP version 5.4 or higher.**
== Installation ==
1. Upload the favorites plugin directory to the wp-content/plugins/ directory
2. Activate the plugin through the Plugins menu in WordPress
3. Visit the plugin settings to configure display options
4. Use the template functions, display settings, or shortcodes to display the favorite button, favorite counts, and/or user favorites.
== Frequently Asked Questions ==
= Does this worked on cached pages? =
Yes, although the buttons may display the incorrect state momentarily. Button states are updated via an AJAX call after page load in order to accommodate cached pages. This may be noticeable on slower servers.
= Is this plugin compatible with Multisite? =
As of version 1.1.0, Favorites is compatible with multisite installations. By default, all shortcodes and template functions will pull data from the site being viewed. Specific site IDs may be passed as parameters for more control. See the documentation for more information.
== Screenshots ==
1. Developer-friendly – easily unenqueue styles if you are combining and minifying your own.
2. Enable for anonymous users and save in the session or a browser cookie. Logged-in users' favorites are saved in a custom user meta field.
3. Optionally add a modal authentication gate for unauthenticated users
4. Enable and display per post type, or use the functions/shortcodes to manually add to templates.
5. Customize the button markup to fit your theme
6. Or use a predefined button type and customize colors to fit your site's style.
7. Every option is customizable, including the loading state for favorite buttons.
8. Customize favorite lists
== Changelog ==
= 2.3.2 =
* Security update.
= 2.3.1 =
* Bug Fix: Fixes issue where only one custom field was being output when multiple were specified in the custom list html.
* Security Update: Removes potential security issue where user may favorite a non-public post, or a post where favorites are not enabled.
= 2.3.0 =
* Security Update: Removes ability for users to manipulate favorites belonging to other users. Thanks to Arne van Hoorn for uncovering this issue.
= 2.2.0 =
* Fixes multisite issue where favorites were not being retrieved correctly.
* Adds setting to require consenting to cookies before saving favorites, in an effort to adhere to GDPR compliance. Note: the modal content that displays when this setting is enabled should be provided by a qualified attorney or legal entity. Should your site already have a cookie consent protocol in place, document-level events are provided for triggering the user preferences.
= 2.1.6 =
* Adds option of redirecting to a page/post by ID if an anonmyous user attempts to favorite an item
* Adds shortcode processing to authentication gate modal content
* Bug fix that was causing unexpected errors in content filtered by 'the_content' filter.
= 2.1.5 =
* Bug fix where button HTML filters were not being applied to AJAX/cache enabled sites. The post id is not available as a parameter on button html on cache-enabled sites.
* Adds additional compatibility for logged-in favoriting on hosts with aggressive server-side caching
= 2.1.4 =
* Post favorite counts using the shortcode [favorite_count] or the functions get_favorites_count/the_favorites_count now update without page reload.
* Adds parameter to the [user_favorites] shortcode for "No Favorites" text. Overrides the plugin setting. [user_favorites no_favorites="Your Custom Text"]
* Updated code that was breaking in PHP versions less than 5.4. End-of-life PHP version support will be dropped in Favorites v3
* Bug fix where total favorite count was showing "1" before a user had favorited any posts
* Adds additional permalink field under the customized listing visual editor
* Bug fix where nonce was not loading correctly on some sites, resulting in an "Incorrect form field" error
* Adds status filter to function filter parameters
= 2.1.3 =
* Bug fix where authentication gate modal was not appearing correctly due to a Javascript error on sites with the cache option disabled.
* Bug fix where lists were being emptied on page load with the cache option enabled.
= 2.1.2 =
* Added additional filters for the listing wrapper CSS classes and the listing element CSS classes. See the plugin website for details.
* Added plugin setting and filter for customizing the button html element type.
* Added a "Development Mode" setting for logging various data to the browser console in order to help with support and debugging.
* Reverted default post types in favorites list to display all post types.
* Updates filters run on authorization gate modal that were conflicting with some themes and plugins.
= 2.1.1 =
* Fixes bug where Favorites admin javascript was loading outside the plugin settings area, causing preventing some sites from saving posts.
= 2.1.0 =
* Option added to enable a modal notification for anonymous users. Modal content is editable under Settings > Favorites > Users. Anonymous users must be disabled, and the "Require Login & Show Modal" must be checked. The content is also available via a filter: favorites/authentication_modal_content. If the plugin css has been disabled and this feature is required, please see the plugin styles for new css classes required for modals to function.
* Button customization options added, including color settings and preset button types. Visit Settings > Favorites > Display & Post Types to customize the button. In addition to now having the ability to choose a preset button type, button colors may be specified to better match your theme without editing CSS files.
* Option added to customize the favorites list. Options are now included for specifying the HTML element type and custom CSS classes for both the list wrapper element and individua listing elements. Additionally, the listings may be fully customized using a standard WordPress editor field.
* Various filters have been added. See the plugin website for a detailed list of available filters.
= 2.0.2 =
* Option added to use a css/html loading indicator in place of an image. Additional filters added for theme use
* Shortcode option added to the favorites list "user_favorites" for including the post thumbnail. To include the thumbnail, pass the option include_thumbnails="true". To specify a thumbnail size, pass it in as an option: thumbnail_size="thumbnail"
* Shortcode option added to the favorites list "user_favorites" for including the post excerpt. To include the excerpt, pass the option include_excerpt="true"
* Filters added for the list thumbnail and list excerpt. See plugin documentation for names and parameters
* Plugin settings redesigned
= 2.0.1 =
* Javascript callback functions have been deprecated in place of events. Deprecated functions will be removed in a later version. Please see the plugin documentation on using the new events
* App namespace renamed to "Favorites". Important: any developers extending the plugin core should update any references in PHP namespaces to \Favorites\
* Plugin text domain updated to "favorites" to follow WordPress requirements
* AJAX actions renamed to remove "simple" prefix
* Bug fix where adding a favorite required a page refresh for it to appear in favorite lists
* Added API function to get the total count of favorites across all posts
* Tested with WordPress 4.8
= 1.2.4 =
* Added option to display favorite counts in admin columns on a per-post type basis. Visit Settings > Favorites > Display to enable the columns.
* Added filter option to change cookie expiration (thanks to Github user rlaan)
= 1.2.3 =
* Bug fix - post type parameter in shortcode being overwritten by javascript on load
= 1.2.2 =
* Bug fix - incorrect list being displayed when passing a specific user id to get_user_favorites_list();
= 1.2.1 =
* Bug fix where [user_favorite_count] shortcode always returning 0 in multisite installations.
* Added filter to customize user list output.
* Tested for WordPress 4.3 compatibility
= 1.2.0 =
* Added functionality to display users who have favorited a post. Use the shortcode [post_favorites] or one of the two new template functions: get_users_who_favorited_post or the_users_who_favorited_post. View the plugin website for options and usage examples.
* Added shortcode and template functions to display a "Clear Favorites" button. Button clears all user favorites when clicked.
* Added developer hooks for before and after a post has been favorited.
* Added developer Javascript callback functions for after the page has loaded, and after a favorite has been submitted.
* Option added to include favorite button in generated list (see "Other Notes" tab or plugins website for template functions and shortcode)
* Option added to customize text that displays in lists when the user has no favorites (visit settings > favorites > display to customize the text)
* Post type(s) parameter added to get_user_favorites_count template function and user_favorite_count shortcode.
* User favorite count now updated dynamically (may require a cache reset if page cache is enabled)
* Bug fix - Invalid posts removed from user favorites (trashed/unpublished posts).
* Other various enhancements and minor bug fixes
= 1.1.4 =
* Fixed bug that allowed multiple button submissions before the previous was processed
= 1.1.3 =
* Option added to hide loading indication on page load.
= 1.1.2 =
* Bug fix in plugin settings when deselecting all automatic post type insertions.
= 1.1.1 =
* Optional filtering added to favorite list template functions. The functions now accept an array of arguments for fine-tuned favorite lists. Visit the documentation for more information.
* An optional "post_type" parameter has been added to the user_favorites shortcode. The parameter allows for filtering of the generated list by post types, and will accept a comma separated list of post types
* Option added to include post favorite count in the button (view settings > favorites > display to enable)
* Button loading state option added (view settings > favorites > display to enable)
* Added template function and shortcode for displaying total number of favorites by user (see documentation for more options)
= 1.1.0 =
* Favorites is now multisite compatible. See documentation for added template function and shortcode parameters.
= 1.0.5 =
* Autoloader bug fix (Thanks to Stefan Oderbolz)
* User List page cache fix
= 1.0.4 =
* User favorites list bug fix
= 1.0.3 =
* Additional bug fixes for logged in users
= 1.0.2 =
* Fixed array error bug for logged in users
= 1.0.1 =
* Fixed bug where logged in user's favorites were pulling from session/cookie rather than saved user meta
* Tested for 4.2 compatibility
= 1.0 =
* Initial release
== Upgrade Notice ==
= 1.2.0 =
* Important: If page cache is enabled on your site, clear the cache immediately after updating.
* Many enhancements and developer/theme features have been added. If page cache is enabled on your site, it may be beneficial to reset the cache. Some generated HTML elements are now output with data attributes that enable dynamic updates. If the cached HTML does not have these data attributes, errors may occur.
= 1.1.3 =
* Option added to hide loading indication on page load. By default, loading indication is turned off. To turn loading indication on, visit settings > favorites > display, and select the checkbox labeld "include loading indicator image on page load"
= 1.1.1 =
* Optional filters added to favorite list functionality. Visit the documentation page for more information.
= 1.1.0 =
* Favorites is now multisite compatible. See documentation for added template function and shortcode parameters.
= 1.0 =
Initial release
== Usage ==
**Favorite Button**
The favorite button can be added automatically to the content by enabling specific post types in the plugin settings. It may also be added to template files or through the content editor using the included functions or shortcodes. The post id may be left blank in all cases if inside the loop. The site id parameter is optional, for use in multisite installations (defaults to current site).
* **Get function:** `get_favorites_button($post_id, $site_id)`
* **Print function:** `the_favorites_button($post_id, $site_id)`
* **Shortcode:** `[favorite_button post_id="" site_id=""]`
**Favorite Count (by Post)**
Total favorites for each post are saved as a simple integer. If a user unfavorites a post, this count is updated. Anonymous users' favorites count towards the total by default, but may be disabled via the plugin settings. The post id may be left blank in all cases if inside the loop.
* **Get function:** `get_favorites_count($post_id)`
* **Print function:** `the_favorites_count($post_id)`
* **Shortcode:** `[favorite_count post_id=""]`
**Favorite Count (by User)**
Displays the total number of favorites a user has favorited. Template functions accept the same filters parameter as the user favorites functions.
* **Get function:** `get_user_favorites_count($user_id, $site_id, $filters)`
* **Print function:** `the_user_favorites_count($user_id, $site_id, $filters)`
* **Shortcode:** `[user_favorites user_id="" site_id="" post_types=""]`
**User Favorites**
User favorites are stored as an array of post ids. Logged-in users' favorites are stored as a custom user meta field, while anonymous users' favorites are stored in either the session or browser cookie (configurable in the plugin settings). If the user id parameter is omitted, the favorites default to the current user. The site id parameter is optional, for use in multisite installations (defaults to current site).
* **Get function (returns array of IDs):** `get_user_favorites($user_id, $site_id)`
* **Get function (returns html list):** `get_user_favorites_list($user_id, $site_id, $include_links, $filters, $include_button, $include_thumbnails = false, $thumbnail_size = 'thumbnail', $include_excerpt = false)`
* **Print function (prints an html list):** `the_user_favorites_list($user_id, $site_id, $include_links, $filters, $include_button, $include_thumbnails = false, $thumbnail_size = 'thumbnail', $include_excerpt = false)`
* **Shortcode (prints an html list, with the option of omitting links):** `[user_favorites user_id="" include_links="true" site_id="" include_buttons="false" post_types="post" include_thumbnails="false" thumbnail_size="thumbnail" include_excerpt="false"]
**List Users Who Have Favorited a Post**
Display a list of users who have favorited a specific post. If the user id parameter is omitted, the favorites default to the current user. The site id parameter is optional, for use in multisite installations (defaults to current site). The get function returns an array of user objects.
* **Get function (returns array of User Objects):** `get_users_who_favorited_post($post_id, $site_id)`
* **Print function (prints an html list):** `the_users_who_favorited_post($post_id = null, $site_id = null, $separator = 'list', $include_anonymous = true, $anonymous_label = 'Anonymous Users', $anonymous_label_single = 'Anonymous User')`
* **Shortcode (prints an html list):** `[post_favorites post_id="" site_id="" separator="list" include_anonymous="true" anonymous_label="Anonymous Users" anonymous_label_single="Anonymous User"]
**Clear Favorites Button**
Displays a button that allows users to clear all of their favorites.
* **Get function:** `get_clear_favorites_button($site_id, $text)`
* **Print function:** `the_clear_favorites_button($site_id, $text)`
* **Shortcode:** `[clear_favorites_button site_id="" text="Clear Favorites"]
**Favorite Count (Across all Posts)**
Displays the total number of favorites for a given site.
* **Get function:** `get_total_favorites_count($site_id)`
* **Print function:** `the_total_favorites_count($site_id)`