readme.txt 3.52 KB
Newer Older
1
2
3
4
5
=== External Permalinks Redux ===
Contributors: ethitter, thinkoomph
Donate link: http://www.thinkoomph.com/plugins-modules/external-permalinks-redux/
Tags: link, redirect, external link, permalink
Requires at least: 3.0
Erick Hitter's avatar
Erick Hitter committed
6
Tested up to: 5.5
7
Stable tag: 1.2
Erick Hitter's avatar
License  
Erick Hitter committed
8
9
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
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

Allows you to point WordPress objects (posts, pages, custom post types) to a URL of your choosing.

== Description ==

Allows users to point WordPress objects (posts, pages, custom post types) to a URL of their choosing, which is particularly useful for injecting non-WordPress content into loops. The object appears normally in any loop output, but visitors to the object will be redirected to the specified URL. The plugin also allows you to choose the type of redirect, either temporary (302), or permanent (301).

Through a filter, the External Permalinks Redux meta box can easily be added to custom post types. There is also a function available for use with WordPress' `add_meta_box` function.

This plugin was originally written for use on WordPress.com VIP. It is inspired by and backwards-compatible with Mark Jaquith's Page Links To plugin, meaning users can switch between plugins without risk of losing any existing external links.

This plugin is translation-ready.

== Installation ==

1. Upload external-permalinks-redux.php to /wp-content/plugins/.
2. Activate plugin through the WordPress Plugins menu.

== Frequently Asked Questions ==

= How can I add support for my custom post type? =
Using the `epr_post_types` filter, one can modify the default array of object types (`post` and `page`) to include additional custom post types or remove the plugin from one of the default post types.

= What other filters does this plugin include? =
* `epr_meta_key_target` - modify the meta key associated with the external URL
* `epr_meta_key_type` - modify the meta key associated with the redirect type
36
* `epr_status_codes` - modify array of available status codes used when redirect is issued
37
38
39

== Changelog ==

40
41
42
43
44
= 1.2 =
* Introduce `get_redirect_data()` method to look up a post ID's redirect.
* Introduce PHPUnit tests
* Conform to current VIP Go Coding Standards.

Erick Hitter's avatar
Erick Hitter committed
45
46
47
48
49
= 1.1 =
* Introduce a filter to change the metabox title for clarity. Does break translation for that string if used.
* Add additional HTML classes in the metabox to aid customization.
* Coding standards and PHPDoc cleanup.

50
51
52
= 1.0.4 =
* Implement singleton pattern for instantiation. Thanks batmoo.

Erick Hitter's avatar
Erick Hitter committed
53
54
55
= 1.0.3 =
* Increase priority of `init` action to ensure that the filters it contains are available to other plugins. Thanks batmoo.

56
57
58
59
60
= 1.0.2 =
* Add status codes filter. Thanks [danielbachhuber](http://wordpress.org/support/topic/plugin-external-permalinks-redux-support-custom-status-codes).
* Correct translation string implementation, removing variable name.
* Miscellaneous cleanup, such as whitespace removal.

61
62
63
64
65
= 1.0.1 =
* Add shortcut function for registering meta box on custom post types. This is included as an alternative to the `epr_post_types` filter discussed in the FAQ.

= 1.0 =
* Initial release in WordPress.org repository.
Erick Hitter's avatar
Erick Hitter committed
66
67
68
69
* Rewrote original WordPress.com VIP plugin into a class and added support for custom post types.

== Upgrade Notice ==

70
71
72
= 1.2 =
Introduces `get_redirect_data()` method along with unit tests and PHPCS cleanup.

73
74
75
= 1.0.4 =
Implements singleton pattern for instantiation. No functional changes are included in this release.

Erick Hitter's avatar
Erick Hitter committed
76
= 1.0.3 =
Erick Hitter's avatar
Erick Hitter committed
77
Ensures that filters are available to plugins and themes. Recommended for anyone trying to hook to those filters.