forked from ErinMorelli/em-beer-manager
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.txt
493 lines (310 loc) · 18.6 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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
=== EM Beer Manager ===
Contributors: ErinMorelli
Donate link: http://www.erinmorelli.com/projects/em-beer-manager/
Tags: beer, beers, brewery, untappd, untappd for business
Requires at least: 3.0.1
Tested up to: 4.8.0
Stable tag: 3.1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Manage and display your beers with WordPress. Integrates simply with Untappd and Untappd for Business. Great for everyone from home brewers to professional breweries!
== Description ==
This plugin allows beer creators from home brewers to professional breweries to easily manage and display their beers. Includes a comprehensive beer management section with a variety of options, including:
* A custom beer "style" taxonomy for classifying your beers pre-populated with styles from Untappd
* A customizable "group" taxonomy for categorizing and grouping your beers
* "Menu" taxonomy for creating beer menus
* Shortcodes and template tags for displaying all or a select number of beers
* Custom meta boxes to store detailed information about each beer, including ABV, IBU, and ingredients
* Beer check-in and rating integration with Untappd
* A "Beer List" widget for simply displaying your beers in sidebars
* A "Recent Check-Ins" widget for displaying recent beer check-ins for your brewery on Untappd
* Custom page display for beers and styles
* [Beta] Import your brewery's beers directly from Untappd
* [Beta] Import your beers and menus from Untappd for Business
= Usage =
Use these shortcodes to display beers in your posts or use the template tags in your theme files:
__Single Beer Display__
These will display a single beer entry given it's ID number (found in "Beers" admin).
* __Shortcode__:
`[beer id={beer id}]`
* __Template tag__:
`<?php echo EMBM_Output_Shortcodes_Beer_display( $beer_id, $args ); ?>`
Where `$beer_id` is required and `$args` is a PHP array of comma-separated `key => value` pairs. For example:
<?php echo EMBM_Output_Shortcodes_Beer_display( 123, array(
'show_profile' => false,
'show_extras' => true,
'show_rating' => false,
'show_checkins' => true,
'checkins_count' => 10
) ); ?>
* __Options__:
For use with both the shortcode and template code.
* __show_profile => `"true, false"`__ (Default = `true`)
*Displays or hides the "Beer Profile" information section*
* __show_extras => `"true, false"`__ (Default = `true`)
*Displays or hides the "More Beer Information" section*
* __show_rating => `"true, false"`__ (Default = `true`)
*Displays or hides the Untappd beer rating*
* __show_checkins => `"true, false"`__ (Default = `true`)
*Displays or hides the Untappd check-ins section*
* __checkins_count => `"number"`__ (Default = `5`, limit is `15`)
*The number of recent Untappd check-ins to display*
__List All Beers__
These will display a formatted listing of all beers.
* __Shortcode__:
`[beer-list]`
* __Template tag__:
`<?php echo EMBM_Output_Shortcodes_List_display( $args ); ?>`
Where `$args` is a PHP array of comma-separated `key => value` pairs. For example:
<?php echo EMBM_Output_Shortcodes_List_display( array(
'show_extras' => false,
'show_rating' => true,
'beers_per_page' => 3,
'orderby' => 'name',
'order' => 'ASC'
) ); ?>
* __Options__:
For use with both the shortcode and template code.
* __show_profile => `"true, false"`__ (Default = `true`)
*Displays or hides the "Beer Profile" information section*
* __show_extras => `"true, false"`__ (Default = `true`)
*Displays or hides the "More Beer Information" section*
* __show_rating => `"true, false"`__ (Default = `true`)
*Displays or hides the Untappd beer rating*
* __style => `"style name"`__ (String e.g. `"India Pale Ale"`)
*Displays only beers belonging to a specific beer style*
* __group => `"group name"`__ (String e.g. `"Seasonal Beers"`)
*Displays only beers belonging to a specific group*
* __exclude => `"beer ids"`__ (Comma-separated list of beer IDs e.g. `"4,23,24"`)
*Hides listed beers from output*
* __beers\_per\_page => `"number"`__ (Default = `-1`, shows all beers on one page)
*Paginates output and displays the given number of beers per page*
* __offset => `"number"`__ (Default = `0`, starts at the first beer)
*Offsets the output of beers by given number*
* __paginate => `"true, false"`__ (Default = `true`)
*Disables/enables pagination*
* __orderby => `"string"`__ (Default = `date`, see [this list](http://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters) for options)
*Orders output by given paramater*
* __order => `"DSC, ASC"`__ (Default = `DSC`)
*Sorts beer list by `orderby` value in ascending or descending order*
== Installation ==
1. Unzip the `em-beer-manager.zip` file to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. See "Usage" section on the Description page to learn more.
== Frequently Asked Questions ==
= Can I use content filters with EM Beer Manager? =
Yes! New in v3.1.0, you can apply content filters to different parts of EM Beer Manager's output:
* `embm_beer_filter_beer` = The full beer post content
* `embm_beer_filter_untappd` = The Untappd check-in button
* `embm_beer_filter_profile` = The beer profile content
* `embm_beer_filter_extras` = The beer extras content
* `embm_beer_filter_rating` = The full beer rating content
* `embm_beer_filter_rating_stars` = Just the stars of the rating content
* `embm_beer_filter_rating_styles` = CSS styles for the rating stars
* `embm_beer_filter_reviews` = The beer reviews content
= Why is an Untappd account required in addition to an UTFB account? =
Untappd for Business (UTFB) account credentials do not work with Untappd's API. In order to link Untappd data to beers imported from UTFB, Untappd API access is also needed.
An Untappd brewery account is not required to work with UTFB. A standard user account will work.
= Where do I find my Untappd for Business API key? =
You can find your API key under the ["API Access Tokens"](https://business.untappd.com/api_tokens) section of your account.
= Why am I seeing a "rate-limit" error? =
From the [Untappd API documentation](https://untappd.com/api/docs):
"All API applications are rate-limited to protect against abuse and keep the platform healthy. The default limit for API access is 100 calls per hour per key."
If you see this message, it means your authenticated API session has reached this limit and any actions that require an API call will be limited until your access is reset in the next hour.
In most cases you should still be able to use all of the Untappd features with cached data, but rare cases may display a rate-limit warning message when no cached data is available.
= What is the 'Labs' section and how risky is it to use? =
New in v2.1.0 is the EM Beer Manager 'Labs'. This is a section where we plan to introduce new and experimental features for users to test. We do test all of the lab features before making them available, but cannot guarantee that there won't be any issues or bugs when using them, since they are still being worked on. If you experience any issues while using a Labs feature, please contact [[email protected]](mailto:[email protected]).
= How do I access EM Beer Manager beers, styles, and groups in the WordPress API? =
Starting with v2.1.0 you can now access and update EM Beer Manager beers, styles, and groups from the [WordPress API](http://v2.wp-api.org/).
Beers can be accessed using `/wp-json/wp/v2/embm_beers` or individually at `/wp-json/wp/v2/embm_beers/<beer_id>`.
Styles can be accessed using `/wp-json/wp/v2/embm_styles` or individually at `/wp-json/wp/v2/embm_styles/<style_id>`.
Groups can be accessed using `/wp-json/wp/v2/embm_groups` or individually at `/wp-json/wp/v2/embm_groups/<group_id>`.
Additionally, beer profile, extras, and Untappd information is available via the API and is able to be updated via POST/PUT calls.
= I accidentally deleted some of the pre-loaded styles, how do I get them back? =
Starting with v2.0.0, users are now able to easily restore any missing styles. Go to the EM Beer Manager settings page. Under the "Settings" tab, click on the "Restore Styles" button. This will restore any missing styles from the pre-populated Untappd list. It will not affect any already existing or any custom styles.
= Nothing is working or there are errors after upgrading to version 1.7.0 =
EM Beer Manager updated the beer database structure in v1.7.0 and should automatically make any necessary changes. However in the case that the automatic update does not work, you will need to uninstall EM Beer Manager and install the latest v1.7.x or higher release to maintain functionality. You will not lose any of your Beer or Styles data when uninstalling the older version.
= How do I display an image of my beer next to its name and description? =
When creating your new beer entry, set the "featured image" option in the sidebar to the beer image you wish to use, it will display alongside the entry when the beer is displayed on your site.
= How do I display a single beer on a page? =
Use the `[beer id=#]` shortcode inside the WordPress page editor to add a beer to any page. Replace the "#" with the ID of the beer you wish to display, which is listed on the "Beers" admin page.
= How do I display a list of all my beers? =
Use the `[beer-list]` shortcode inside the WordPress page editor to add a list of all your beers to any page.
You can display only beers from a single group using the `group` option, e.g.: `[beer-list group="Seasonal Beers"]`
You can display only beers from a single style using the `style` option, e.g.: `[beer-list style="India Pale Ale"]`
= I don't want to show that big grey box of information, how do I get rid of it? =
For both the `[beer id=#]` and `[beer-list]` shortcodes there are 2 optional attributes of `show_profile` and `show_extras`. Set both of these to `false` to hide the grey box.
Example: `[beer-list show_profile="false" show_extras="false"]`
= What's the difference between `show_profile` and `show_extras`? =
The `show_profile` setting refers to all the content in the "Beer Profile" information stored for each beer. This includes ABV, IBU, Hops, Malts, Additions, and Yeast.
The `show_extras` setting refers to the "Extra Beer Information" content stored for each beer. This includes Beer Number, Availability, and Additional Notes.
= Why isn't the Untappd check-in button hidden when I set `show_extras` to false? =
The Untappd check-in integration is handled separately from the `show_extras` setting. To hide the button for a single beer, make sure the "Untappd Check-in URL" box is empty - a square Untappd check-in icon will appear on the "Beers" admin page next to the beers where the button is active. You can also completely disable the Untappd options through the "EM Beer Manager" settings page.
= My beer, style, or group pages are not displaying or are showing a 404 error =
Try refreshing your permalinks by going to "Settings" -> "Permalinks" and clicking the "Save Settings" button. If you are running EM Beer Manager 1.7.1 or earlier, it may be due to your site's theme overriding the EM Beer Manager templates. We recommend updating to version 1.8.0 or higher, but you can also edit the templates in the plugin file to suit your needs. They're located in wp-content -> plugins -> em-beer-manager -> templates.
== Screenshots ==
1. The beer post type list page
2. Extra beer post metaboxes
3. Pre-populated styles taxonomy
4. Plugin settings page
5. Single beer page display
6. Beer list widget options & display
7. Untappd check-in widget options & display
== Changelog ==
= 3.1.0 =
* [NEW] Connect to and import beers/menus from your Untappd for Business account
* [NEW] Sync your imported beers with changes from Untappd
* [NEW] Beer images now link to their respective beer
* [FIXED] Bug with how beer styles were displaying in titles
= 3.0.5 =
* [FIXED] Broken brewery account authentication for Labs
= 3.0.4 =
* [FIXED] PHP compatibility issue with Untappd authentication
= 3.0.3 =
* [FIXED] Minor bugs related to logging in to Untappd
= 3.0.2 =
* [FIXED] Compatibility issue with PHP versions < 5.4
= 3.0.1 =
* [FIXED] Untappd ratings star color and opacity not being set after upgrade
* [FIXED] User settings not being saved after upgrade
* [FIXED] Untappd ratings stars displaying output error
= 3.0.0 =
* [NEW] Display Untappd ratings & check-ins for individual beers
* [NEW] Associate an existing beer with an Untappd beer
* [LABS] Import access to all of a brewery's Untappd beers, instead of just 15
* [LABS] Fixed ID importing, which was throwing an incorrect error
* Moved Untappd authentication out of Labs, available to all users, not just breweries
* Updated Untappd Check-ins widget to work with Untappd API
= 2.1.6 =
* Fixing WP REST API compatibility issue after 4.6.1 upgrade
= 2.1.5 =
* Added "offset" option to the [beer-list] shortcode
= 2.1.4 =
* Adding Brazilian Portuguese (pt_BR) language files
= 2.1.3 =
* Updated translation POT
* Updated Untappd graphics to reflect the company's branding, as per their documentation
* Beers imported from Untappd will now have their published date set by their Untappd creation date
* The Untappd check-in widget's brewery ID will now auto-populate with your brewery's ID if you've authenticated with Labs
* Pre-populated styles will now be populated from Untappd instead of BeerAdvocate
* Fixed 'undefined function' error
= 2.1.2 =
* Under-the-hood localization improvements
* Added updated translation POT
* Added new Norwegian (nb_NO) language translation - *thanks to __Lars Kvisle__!*
= 2.1.1 =
* Added PUT/POST support for beer metadata via the WordPress API
* Further improvements to the 'Import from Untappd' Labs feature
= 2.1.0 =
* Added new 'Labs' section with an experimental import from Untappd feature
* Added ability to select which set of Untappd icons to use
* Added integration with WordPress API - *thanks to __tlongren__ for his help with this!*
* Updated translation POT to latest version
= 2.0.1 =
* Fixed an issue with the `[beer]` shortcode where debugging output was being output
* Fixed issue where the option to enable/disable comments was not being saved in the admin settings
= 2.0.0 =
* Massive admin settings page layout overhaul
* Added new "Restore Styles" button to admin settings page
* Renamed template tag functions and restructured input format
* Improved overall CSS to be more compatible with custom themes
* Lots of under-the-hood code improvements and cleanup
* Updated localization POT
= 1.9.6 =
* Fixed 'Warning: Missing argument' error
= 1.9.5 =
* Added new "Beer Number" field to beers post
* Updated admin CSS to blend with WP 4.3+ styles
* Updated beer styles list to populate from BeerAdvocate
= 1.9.4 =
* Fixed localization and translation issues
* Updated .POT language file to latest version
= 1.9.3 =
* Fixed bug with beer-list shortcode pagination not working on index pages
= 1.9.2 =
* Fixed major issue with comments setting overriding site-wide comments
= 1.9.1 =
* Fixed issue with content filter being overridden by other plugins
= 1.9.0 =
* Fixed issue with language textdomain files not loading properly
* Fixed issue with p and br tags not displaying properly in beer posts
* Added new filter options to "beer-list" plugin: paginate, orderby, and order
* Added ability to enable/disable commenting on beers
= 1.8.1 =
* Fixed a bug with the Beer List shortcode not displaying groups properly
* Added "beer count" control to Beer List widget
= 1.8.0 =
* Updated compatibility with WP v3.6
* Removed template files & added filters to make single beer, group taxonomy, and style taxonomy displays integrate more universally with themes
* Added new settings to control how single, group, and style pages are displayed
* Styles will now populate with styles list courtesy of BeerPal
= 1.7.1 =
* Fixed a bug with the beer list shortcode/template code throwing a "Group" error
= 1.7.0 =
* Renamed all EMBM custom post types and taxonomies to include embm_ prefix
* Added new "Group" taxonomy with the ability to customize slug
* "Styles" taxonomy is no longer hierarchical
* Updated "Beer List" widget, shortcode, and template tag to include "Group" filters
* Added "Group" page template
* Fixed a number of escaped input errors being thrown on the settings page
= 1.6.1 =
* Fixed a bug that was throwing an invalid function warning on the settings page
= 1.6.0 =
* Added localization POT
* Added new "Recent Untappd Check-Ins" widget
* Added new settings option for Untappd brewery ID
* Updated settings page with help documentation
= 1.5 =
* Added translatable strings for localization
* Added new "Beer List" widget to display a list of beers with a number of display options
* Added themed template files for styles and single beer page display
* Fixed bug that caused plugin activation to throw a header error
= 1.0 =
* Initial plugin release
== Upgrade Notice ==
= 3.1.0 =
Adds support for Untappd for Business accounts
= 3.0.5 =
Critical bug fixes related to Untappd brewery authentication
= 3.0.4 =
Bug fixes related to Untappd authentication
= 3.0.3 =
Minor bugs related to logging in to Untappd
= 3.0.2 =
More critical bug fixes for version 3
= 3.0.1 =
Critical bug fixes for 3.0.0 upgrade
= 3.0.0 =
Fixes a number of lingering small bugs. Adds a number of new Untappd integration features.
= 2.1.3 =
Fixed 'undefined function' error bug
= 2.1.2 =
Plugin localization overhaul and new Norwegian translation.
= 2.0.1 =
Fixed broken beer shortcode output
= 2.0.0 =
Added "Restore Styles" feature, improved template tag functions, improved CSS compatibility
= 1.9.4 =
Plugin localization and translation is now working properly
= 1.9.2 =
Fixed major issue with comments setting overriding site-wide comments
= 1.9.1 =
Minor bug fix for conflicts with other plugins overriding content filters
= 1.8.1 =
Minor bug fixes and new beer list widget options
= 1.8.0 =
Upgraded templates, permalinks need to be refreshed
= 1.7.1 =
Fixed beer list shortcode "Group" error
= 1.7.0 =
Major bug fixes and a new "Group" taxonomy
= 1.6.1 =
Fixed an invalid function warning bug
= 1.5 =
Fixed plugin activation error bug
== Translations ==
I would love to be able to expand this section - let me know if you are able to contribute!
* English
* Icelandic (is_IS) - *thanks to __[rodonmanes](http://bjorspjall.is)__*
* Norwegian Bokmål (nb_NO) - *thanks to __[Lars Kvisle](http://www.lars.kvisle.no)__*
* Brazilian Portuguese (pt_BR) - *thanks to __Lucas Alexandre__*