/
readme.txt
165 lines (110 loc) · 6.1 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
=== Songkick Concerts and Festivals ===
Contributors: saleandro, coox
Tags: songkick, concerts, events, festivals, widget
WordPress Version: 5.2.1 or higher
Tested up to: 6.0.0
Stable tag: 0.9.7
This plugin lets you display events for a Songkick user, artist, venue, or metro area on your WordPress blog, as a widget or shortcode.
== Description ==
This plugin lets you display upcoming or past events for a Songkick user, artist, venue, or metro area on your WordPress blog.
Events can be displayed by adding the Songkick widget to your template, or by adding the shortcode [songkick_concerts_and_festivals] anywhere in your blog.
= Features =
* Upcoming events for an artist
* Past events for an artist
* Upcoming events for a venue
* Upcoming events for a user
* Past events for a user
* Upcoming events for a metro area. A metro area is a city or a collection of cities that Songkick uses to notify users of concerts near them.
* Widget or shortcode format
* Show events for multiple artists, users, venues, or metro areas.
* Paginated list of events
* HTML markup with support for events as defined by [Schema.org](http://www.schema.org/)
= Requirements =
* This plugin uses a non-commercial Songkick API key. If you have a commercial website, you’ll need your own Songkick API key. Please read through [Songkick’s API terms of use](http://www.songkick.com/developer/api-terms-of-use). Apply for a key here: [Songkick API docs](http://www.songkick.com/developer)
* This plugin requires PHP 5.6.20 or higher
= Settings =
Go to the Settings page to configure default options for the plugin. You can also specify your settings under Plugins/Widget or via shortcode options.
* For a user, simply put your username in the admin interface.
* For an artist, you should use the artist’s Songkick id, as shown in the url for your artist page. For example, the url "http://www.songkick.com/artists/123-your-name" has the id "123".
* The same goes for metro areas: "http://www.songkick.com/metro_areas/123-city-name" has the id "123".
* And venues: "http://www.songkick.com/venues/123-venue-name" has the id "123".
= Widget =
Go to the admin Widgets page and simply drag the widget into a sidebar and configure it.
= Shortcode =
Add the shortcode [songkick_concerts_and_festivals] in the content of any blog post.
When using a shortcode, you can set which artist, venue, metro area, or user you want to display events for, allowing you to show events for different entities:
* Users: `[songkick_concerts_and_festivals songkick_id=your_username songkick_id_type=user]`
* Artists: `[songkick_concerts_and_festivals songkick_id=your_artist_id songkick_id_type=artist]`
* Venues: `[songkick_concerts_and_festivals songkick_id=your_venue_id songkick_id_type=venue]`
* Metro areas: `[songkick_concerts_and_festivals songkick_id=your_metro_area_id songkick_id_type=metro_area]`
Override shortcode settings:
* gigography=true|false
* number_of_events=integer
* show_pagination=true|false
* no_calendar_style=true|false — removes the calendar style from the event dates
* order=asc|desc - sort order for artist or user events
= PHP code =
You can call the shortcode method directly in your PHP code:
`<?php echo do_shortcode('[songkick_concerts_and_festivals]'); ?>`
= Blogs using this plugin =
Know any blogs using this plugin? Let me know!
= Contribute =
This is an open source project that I maintain during my spare time. I welcome contributions!
The code lives on [Github](http://github.com/saleandro/songkick-wp-plugin). To send your contribution, fork my project, make your lovely changes, and send me a [pull request](http://help.github.com/send-pull-requests/). Thanks :)
== Installation ==
1. Upload the directory "songkick_concerts_and_festivals" to the "/wp-content/plugins/" directory
1. Activate the plugin through the "Plugins" menu
1. Go to the Settings page for Songkick or the Widgets page and set your username/artist/venue/metro area ID.
1. Please read through [Songkick’s API terms of use](http://www.songkick.com/developer/api-terms-of-use). If you have a commercial website, please apply for your own API key here: http://www.songkick.com/developer and configure it on the Settings page.
1. Add the widget to a sidebar or the shortcode anywhere in your blog.
== Screenshots ==
1. Widget for a user.
== Changelog ==
= 0.6 =
* Added shortcode.
= 0.7 =
* Fixed some warnings.
* Made calendar date style inline.
= 0.8 =
* Fixed bug where shortcode content would always display on top of other content.
= 0.9 =
* Default options can be overridden when calling shortcode function. This means you can use the plugin for different users and artists.
See Songkick’s admin settings for details.
= 0.9.1 =
* Refactored events and presentable event code.
* Improved exception handling and error logging (thanks [Ethan](https://github.com/ezmiller/songkick-plugin-ethanmod)).
* Improved documentation.
* Added option to hide calendar style for dates (no_calendar_style=true)
= 0.9.2 =
* Support for displaying metro area events.
= 0.9.3 =
* Support for displaying venue events.
* Markup with support for events as defined by [Schema.org](http://www.schema.org/)
* Paginated list of events for shortcode option.
= 0.9.4 =
* Reimplementation of the Widget class. Allows for multilple Widget instances.
* Remove requirement for an API key for *non-commercial* websites.
= 0.9.4.1 =
* Fixing up and removing warnings
= 0.9.4.2 =
* Sort order of past events is descending
= 0.9.4.3 =
* Bug fix: Fixing error when displaying a user's upcoming events
= 0.9.4.4 =
* Catching any error when testing Songkick API key. Some users reported seeing a "name lookup" error on the Settings page.
= 0.9.4.5 =
* Option to turn off API caching.
= 0.9.4.6 =
* Display end date of festivals.
= 0.9.4.7 =
* Add Italian translation
= 0.9.4.8 =
* Use __construct instead of classname as this will be deprecated
= 0.9.4.9 =
* BUG fix: correctly localise date strings in calendar
= 0.9.5 =
* Upgrade to support PHP 8
= 0.9.6 =
* Bug fix: prevent settings page from breaking when Songkick API is unavailable
= 0.9.7 =
* Use https to connect to Songkick API