readme.txt 2.97 KB
Newer Older
Erick Hitter's avatar
Erick Hitter committed
1 2
=== Date-based Taxonomy Archives ===
Contributors: ethitter
Erick Hitter's avatar
Erick Hitter committed
3
Donate link: https://ethitter.com/donate/
Erick Hitter's avatar
Erick Hitter committed
4 5
Tags: archive, taxonomy, taxonomies, date
Requires at least: 3.4
Erick Hitter's avatar
v0.3.1  
Erick Hitter committed
6 7
Tested up to: 4.2
Stable tag: 0.3.1
Erick Hitter's avatar
Erick Hitter committed
8 9 10
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

11 12 13 14 15 16 17 18 19 20
Add support for date-based taxonomy archives. Also includes a function for outputting archive links.

== Description ==

Add support for date-based taxonomy archives.

Includes a function for rendering an unordered list of years with months, linked to corresponding date-based taxonomy archive, nested therein.

**This plugin is intended for use by plugin and theme developers. It simply adds support for date-based taxonomy archives, but has no native user interface.**

21 22
**Development is over on GitHub: https://github.com/ethitter/Date-based-Taxonomy-Archives/.**

23 24 25 26 27 28 29 30 31 32 33 34
== Installation ==

1. Upload date-based-taxonomy-archives to /wp-content/plugins/.
2. Activate plugin through the WordPress Plugins menu.
3. Go to Settings > Permalinks and click _Save Changes_ to refresh permalinks.

== Frequently Asked Questions ==

= How do I use this plugin? =
Add the function `date_based_taxonomy_archives()` to any template element that appears on a taxonomy archive. The function accepts an array containing the following arguments:

* `taxonomies` - array of taxonomy slugs.
35
* `show_post_count` - boolean value specifying whether or not to display show counts in parenthesis after archive links.
36 37 38 39 40 41 42 43 44 45 46
* `limit` - integer specifying the number of archive links to show. Omit to show all archive links for the specified taxonomy.
* `before` - output to display before archive link.
* `after` - output to display after archive link.
* `echo` - boolean value specifying whether to echo or return archive links.

= What filters does this plugin include? =

* `date_based_taxonomy_archives_args` - applied to arguments passed to `date_based_taxonomy_archives()` at runtime.

== Changelog ==

Erick Hitter's avatar
v0.3.1  
Erick Hitter committed
47 48 49
= 0.3.1 =
* Security update: correct misuse of `add_query_arg()` as identified by Sucuri: https://blog.sucuri.net/2015/04/security-advisory-xss-vulnerability-affecting-multiple-wordpress-plugins.html.

50 51 52 53 54 55 56
= 0.3 =
* Remove unnecessary uses of `$wpdb->prepare()` that were incorrectly implemented, resulting in PHP warnings when `WP_DEBUG` was enabled.
* Convert plugin to a singelton pattern instead of relying on a global variable.
* Protect class variables and expose them only through a magic getter. Allows for more flexibility in adding class variables in the future.
* Localize large post counts for display, when requested.
* Correct phpdoc implementation.

57
= 0.2 =
58
* Initial public release
59 60 61

== Upgrade Notice ==

Erick Hitter's avatar
v0.3.1  
Erick Hitter committed
62 63 64
= 0.3.1 =
Security update: correct misuse of `add_query_arg()` as identified by Sucuri: https://blog.sucuri.net/2015/04/security-advisory-xss-vulnerability-affecting-multiple-wordpress-plugins.html.

65 66 67
= 0.3 =
Maintenance release encouraged for all users. Of note, resolves a PHP warning due to an improper use of `$wpdb->prepare()`.

68
= 0.2 =
69
Initial public release