Redirects Plugin
This plugin allows you to easily manage redirects for your application from within your Admin Panel. It does so by adding a redirects
collection to your config that allows you specify a redirect from one URL to another. Your front-end application can use this data to automatically redirect users to the correct page using proper HTTP status codes. This is useful for SEO, indexing, and search engine ranking when re-platforming or when changing your URL structure.
For example, if you have a page at /about
and you want to change it to /about-us
, you can create a redirect from the old page to the new one, then you can use this data to write HTTP redirects into your front-end application. This will ensure that users are redirected to the correct page without penalty because search engines are notified of the change at the request level. This is a very lightweight plugin that will allow you to integrate managed redirects for any front-end framework.
Core features
- Adds a
redirects
collection to your config that:- includes a
from
andto
fields - allows
to
to be a document reference
- includes a
Installation
Install the plugin using any JavaScript package manager like pnpm, npm, or Yarn:
Basic Usage
In the plugins
array of your Payload Config, call the plugin with options:
Options
Option | Type | Description |
---|---|---|
collections | string[] | An array of collection slugs to populate in the to field of each redirect. |
overrides | object | A partial collection config that allows you to override anything on the redirects collection. |
redirectTypes | string[] | Provide an array of redirects if you want to provide options for the type of redirects to be supported. |
redirectTypeFieldOverride | Field | A partial Field config that allows you to override the Redirect Type field if enabled above. |
Note that the fields in overrides take a function that receives the default fields and returns an array of fields. This allows you to add fields to the collection.
TypeScript
All types can be directly imported:
Examples
The Templates Directory also contains an official Website Template and E-commerce Template, both of which use this plugin.