-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
186 lines (126 loc) · 8.72 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
=== Linkify Tags ===
Contributors: coffee2code
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6ARCFJ9TX3522
Tags: tag, tags, link, linkify, widget
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Requires at least: 3.3
Tested up to: 6.6
Stable tag: 2.4
Turn a string, list, or array of tag IDs and/or slugs into a list of links to those tag archives. Provides a widget and template tag.
== Description ==
The plugin provides a widget called "Linkify Tags" as well as a template tag, `c2c_linkify_tags()`, which allow you to easily specify tags to list and how to list them. Tags are specified by either ID or slug. See other parts of the documentation for example usage and capabilities.
Links: [Plugin Homepage](https://coffee2code.com/wp-plugins/linkify-tags/) | [Plugin Directory Page](https://wordpress.org/plugins/linkify-tags/) | [GitHub](https://github.com/coffee2code/linkify-tags/) | [Author Homepage](https://coffee2code.com)
== Installation ==
1. Install via the built-in WordPress plugin installer. Or install the plugin code inside the plugins directory for your site (typically `/wp-content/plugins/`).
2. Activate the plugin through the 'Plugins' admin menu in WordPress
3. Optional: Use the `c2c_linkify_tags()` template tag in one of your templates (be sure to pass it at least the first argument indicating what tag IDs and/or slugs to linkify -- the argument can be an array, a space-separate list, or a comma-separated list). Other optional arguments are available to customize the output.
4. Optional: Use the "Linkify Tags" widget in one of the sidebars provided by your theme.
== Screenshots ==
1. The plugin's widget configuration.
== Frequently Asked Questions ==
= What happens if I tell it to list something that I have mistyped, haven't created yet, or have deleted? =
If a given ID/slug doesn't match up with an existing tag then that item is ignored without error.
= How do I get items to appear as a list (using HTML tags)? =
Whether you use the template tag or the widget, specify the following information for the appropriate fields/arguments:
Before text: `<ul><li>` (or `<ol><li>`)
After text: `</li></ul>` (or `</li></ol>`)
Between tags: `</li><li>`
= Does this plugin include unit tests? =
Yes. The tests are not packaged in the release .zip file or included in plugins.svn.wordpress.org, but can be found in the [plugin's GitHub repository](https://github.com/coffee2code/linkify-tags/).
== Developer Documentation ==
Developer documentation can be found in [DEVELOPER-DOCS.md](https://github.com/coffee2code/linkify-tags/blob/master/DEVELOPER-DOCS.md). That documentation covers the template tag and hook provided by the plugin.
As an overview, this is the template tag provided by the plugin:
* `c2c_linkify_tags()` : Template tag to display links to each of any number of tags specified via tag IDs/slugs. You can customize text to show before and/or after the entire listing, between each tag, and what to display (if anything) when no tags are listed.
This is the hook provided by the plugin:
* `c2c_linkify_tags` : Allows use of an alternative approach to safely invoke `c2c_linkify_categories()` in such a way that if the plugin were deactivated or deleted, then your calls to the function won't cause errors in your site.
== Changelog ==
= 2.4 (2024-08-20) =
Highlights:
This recommended release features improvements to widget implementation, adds some hardening measures, notes compatibility through WP 6.6+, removes unit tests from release packaging, updates copyright date (2024), and other code improvements and minor changes.
Details:
* Widget:
* New: Extract base widget functionality common amongst my Linkify family of plugins into reusable base class
* Change: Define a default 'none' message so that something is shown when no tags are specified
* Change: Improve spacing in block editor around widget input field help text
* New: Add `get_config()` to retrieve configuration
* Hardening: Escape some variables prior to being output
* New: Add unit tests
* Change: Update version to 005
* New: Extract code for creating link to category's archive into new `__c2c_linkify_tags_get_tag_link()`
* Change: Tweak descriptions to clarify that the links are to each tag's archive
* Change: Add default values for optional arguments to inline parameter documentation
* Change: Note compatibility through WP 6.6+
* Change: Prevent unwarranted PHPCS complaints about unescaped output (HTML is allowed)
* Change: Add inline comment for translators
* Change: Update copyright date (2024)
* Change: Reduce number of 'Tags' from `readme.txt`
* Change: Remove development and testing-related files from release packaging
* Hardening: Unit tests: Prevent direct web access to `bootstrap.php`
* New: Add some potential TODO items
= 2.3.1 (2023-08-22) =
* Fix: Fix some typos in documentation
* Change: Note compatibility through WP 6.3+
* Change: Update copyright date (2023)
* New: Add `.gitignore` file
* Unit tests:
* Allow tests to run against current versions of WordPress
* New: Add `composer.json` for PHPUnit Polyfill dependency
* Change: Prevent PHP warnings due to missing core-related generated files
= 2.3 (2021-10-20) =
Highlights:
This minor release removes support for the long-deprecated `linkify_tags()`, adds DEVELOPER-DOCS.md, notes compatibility through WP 5.8+, and minor reorganization and tweaks to unit tests.
Details:
* Change: Remove long-deprecated function `linkify_tags()`
* New: Add DEVELOPER-DOCS.md and move template tag and hooks documentation into it
* Change: Tweak installation instruction
* Change: Note compatibility through WP 5.8+
* Unit tests:
* Change: Restructure unit test directories
* Change: Move `phpunit/` into `tests/phpunit/`
* Change: Move `phpunit/bin/` into `tests/`
* Change: Remove 'test-' prefix from unit test file
* Change: In bootstrap, store path to plugin file constant
* Change: In bootstrap, add backcompat for PHPUnit pre-v6.0
_Full changelog is available in [CHANGELOG.md](https://github.com/coffee2code/linkify-tags/blob/master/CHANGELOG.md)._
== Upgrade Notice ==
= 2.4 =
Recommended update: improved widget implementation, added some hardening measures, noted compatibility through WP 6.6+, removed unit tests from release packaging, updated copyright date (2024), and other code improvements and minor changes.
= 2.3.1 =
Trivial update: noted compatibility through WP 6.3+, updated unit tests to run against latest WordPress, fixed some typos in inline documentation, and updated copyright date (2023)
= 2.3 =
Minor update: removed support for long-deprecated `linkify_tags()`, added DEVELOPER-DOCS.md, noted compatibility through WP 5.8+, and minor reorganization and tweaks to unit tests
= 2.2.6 =
Trivial update: noted compatibility through WP 5.7+ and updated copyright date (2021).
= 2.2.5 =
Trivial update: Restructured unit test file structure, added a TODO.md file, and noted compatibility through WP 5.5+.
= 2.2.4 =
Trivial update: Updated a few URLs to be HTTPS and noted compatibility through WP 5.4+.
= 2.2.3 =
Trivial update: modernized unit tests, created CHANGELOG.md to store historical changelog outside of readme.txt, noted compatibility through WP 5.3+, and updated copyright date (2020)
= 2.2.2 =
Trivial update: minor hardening, noted compatibility through WP 5.1+, and updated copyright date (2019)
= 2.2.1 =
Trivial update: fixed some unit tests, noted compatibility through WP 4.7+, updated copyright date
= 2.2 =
Minor update: minor updates to widget code and unit tests; verified compatibility through WP 4.4; updated copyright date (2016).
= 2.1.3 =
Bugfix update: Prevented PHP notice under PHP7+ for widget; noted compatibility through WP 4.3+
= 2.1.2 =
Trivial update: noted compatibility through WP 4.1+ and updated copyright date
= 2.1.1 =
Trivial update: noted compatibility through WP 4.0+; added plugin icon.
= 2.1 =
Moderate update: better validate data received; added unit tests; noted compatibility through WP 3.8+
= 2.0.4 =
Trivial update: noted compatibility through WP 3.5+
= 2.0.3 =
Trivial update: noted compatibility through WP 3.4+; explicitly stated license
= 2.0.2 =
Trivial update: noted compatibility through WP 3.3+ and minor readme.txt tweaks
= 2.0.1 =
Trivial update: noted compatibility through WP 3.2+ and minor code formatting changes (spacing)
= 2.0 =
Feature update: added widget, deprecated `linkify_tags()` in favor of `c2c_linkify_tags()`, renamed action from 'linkify_tags' to 'c2c_linkify_tags', added Template Tags, Screenshots, and FAQ sections to readme, noted compatibility with WP 3.1+, and updated copyright date (2011).
= 1.2 =
Minor update. Highlights: added filter to allow alternative safe invocation of function; verified WP 3.0 compatibility.