Redirection

PHP JavaScript

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.

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.

Installation

Redirection can be installed by visiting the WordPress.org plugin page:

https://wordpress.org/plugins/redirection/

Customisation

Request Information

The following WordPress filters are available for customisation of a server requests:

redirection_request_url - The request URL
redirection_request_agent - The request user agent
redirection_request_referrer - The request referrer
redirection_request_ip - The request IP address
redirection_request_cookie - The request cookie
redirection_request_header - The request HTTP header

Logging

The following WordPress filters are available for customisation of logged data:

redirection_404_data - Data to be inserted into the 404 table
redirection_log_data - Data to be inserted into the redirect log table
redirection_log_404 - Return true if the current 404 page should be logged, false otherwise
redirection_log - Action fired when something is logged

Note that returning false from the filter will bypass the log.

Redirect source and target

redirection_url_source - The original URL used before matching a request. Return false to stop any redirection
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

Actions

redirection_do_nothing - Called when a 'do nothing' action fires

Dynamic URL data

The following special words can be inserted into a target URL:

%userid% - Insert user's ID
%userlogin% - Insert user's login name
%userurl% - Insert user's custom URL

Management

redirection_permalink_changed - return boolean if a post's permalink has changed
redirection_remove_existing - fired when a post changes permalink and we need to clear existing redirects that might affect it
redirection_monitor_created - fired when a redirect is created for a monitor post type. Supplied with the new redirect, old post, and post ID
redirection_monitor_types - Modify what post types are monitored by Redirection
redirection_create_redirect - Modify redirect data before a redirect is created
redirection_update_redirect - Modify redirect data before a redirect is updated
redirection_validate_redirect - Validate redirect data
red_default_options - The default Redirection options
redirection_save_options - Modify options before they are saved
redirection_redirect_deleted - Action fire when a redirect is deleted
redirection_redirect_updated - Action fire when a redirect is updated/created
redirection_redirect_deleted - Action fire when a redirect is deleted

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.

Permissions

Access to the Redirection admin interface is given to users who can manage_options. You can modify this with the filter redirection_role, returning your own WordPress access level or capability

Building

Redirection is mostly a PHP plugin, but does contain files that need to be built. For this you'll need Gulp, Node, and Yarn installed. Install required modules with:

yarn install

Language files

gulp pot - Updates language files

React

Some parts of the UI are React and can be built with:

yarn run dist

To use in development mode then set REDIRECTION_DEV_MODE to true in PHP, and run:

yarn start

This will start Webpack in hot-reload mode, and you can make changes to JS files and have them auto-loaded.

Releasing

Finally, to produce a release copy:

gulp svn

Support

Please raise any bug reports or enhancement requests here. Pull requests are always welcome.

You can find a more detailed description of the plugin on the Redirection home page

Translations can be added here:

https://translate.wordpress.org/projects/wp-plugins/redirection

pfiled/redirection