| 1 |
# Redirection |
| 2 |
|
| 3 |
[](https://travis-ci.org/johngodley/redirection](https://travis-ci.org/johngodley/redirection](https://travis-ci.org/johngodley/redirection) |
| 4 |
|
| 5 |
Redirection is a WordPress plugin to manage 301 redirections, keep track of 404 errors, and generally tidy up any loose ends your site may have. This is particularly useful if you are migrating pages from an old website, or are changing the directory of your WordPress installation. |
| 6 |
|
| 7 |
Note: this is the current 'trunk' version of Redirection. It may be newer than what is in the WordPress.org plugin repository, and should be considered experimental. |
| 8 |
|
| 9 |
## Installation |
| 10 |
Redirection can be installed by visiting the WordPress.org plugin page: |
| 11 |
|
| 12 |
https://wordpress.org/plugins/redirection/ |
| 13 |
|
| 14 |
## Customisation |
| 15 |
|
| 16 |
### Request Information |
| 17 |
|
| 18 |
The following WordPress filters are available for customisation of a server requests: |
| 19 |
|
| 20 |
- `redirection_request_url` - The request URL |
| 21 |
- `redirection_request_agent` - The request user agent |
| 22 |
- `redirection_request_referrer` - The request referrer |
| 23 |
- `redirection_request_ip` - The request IP address |
| 24 |
|
| 25 |
### Logging |
| 26 |
|
| 27 |
The following WordPress filters are available for customisation of logged data: |
| 28 |
|
| 29 |
- `redirection_404_data` - Data to be inserted into the 404 table |
| 30 |
- `redirection_log_data` - Data to be inserted into the redirect log table |
| 31 |
|
| 32 |
### Redirect source and target |
| 33 |
|
| 34 |
- `redirection_url_source` - The original URL used before matching a request. Return false to stop any redirection |
| 35 |
- `redirection_url_target` - The target URL after a request has been matched (and after any regular expression captures have been replaced). Return false to stop any redirection |
| 36 |
|
| 37 |
### Dynamic URL data |
| 38 |
|
| 39 |
The following special words can be inserted into a target URL: |
| 40 |
|
| 41 |
- `%userid%` - Insert user's ID |
| 42 |
- `%userlogin%` - Insert user's login name |
| 43 |
- `%userurl%` - Insert user's custom URL |
| 44 |
|
| 45 |
### Management |
| 46 |
|
| 47 |
- `redirection_permalink_changed` - return boolean if a post's permalink has changed |
| 48 |
- `redirection_remove_existing` - fired when a post changes permalink and we need to clear existing redirects that might affect it |
| 49 |
|
| 50 |
Additionally, if the target URL is a number without any slashes then Redirection will treat it as a post ID and redirect to the full URL for that post. |
| 51 |
|
| 52 |
## Support |
| 53 |
|
| 54 |
Please raise any bug reports or enhancement requests here. Pull requests are always welcome. |
| 55 |
|
| 56 |
You can find a more detailed description of the plugin on the [](http://urbangiraffe.com/plugins/redirection/Redirection home page](http://urbangiraffe.com/plugins/redirection/](http://urbangiraffe.com/plugins/redirection/) |
| 57 |
|
| 58 |
Translations can be added here: |
| 59 |
|
| 60 |
https://translate.wordpress.org/projects/wp-plugins/redirection |
| 61 |
|
