joomla:url_redirecter:documentation

Documentation

URL-Redirecter ships with a Management Component, accessible through your Joomla! Administrator Backend: Components » URL Redirect:



This view allows to:

  • Publish one or more selected Redirects. When being published, these redirects are active.
  • Unpublish one or more selected Redirects. When being unpublished, these redirects are inactive.
  • Trash one ore more selected Redirects. This removes these redirects.
  • Edit the currently selected Redirect.
  • New creates a new Redirect.



The order of individual redirects is relevant is using Regular Expression based redirects or when Redirecting for a particular type of Browser or User Agent. Set the Order for these type of redirects with the arrows or by entering the ordering sequence into the number fields, in case your order of the redirects is relevant.

Each individual Redirect is flexible to support various types of Redirection and matching of the Redirect to any incoming URL Request:


Meaning

Redirect any incoming URL Request of '/joomla-15/support'

-> to the Article named 'Support and Documentation'

-> with using a '301 - Moved Permanently" server response.

All requests to 'http://my.supersite.tld/joomla-15/support' will redirect to the selected Article 'Support and Documentation'



This matches the incoming URL Request to the Compare Request URL, and activates this Redirect if both do match. Notice the with URL Option for the Compare Request URL which sets the type of comparison to a direct match with the URL entered in that following field. This URL is always relative to the Server Address where your Joomla! site is installed on.

The target for this redirection is set to Redirect to and to redirect to Article, to redirect the incoming request to a specific Article. Use the [Select] button to select the Article which shall be the redirection target.

Only for Browser User Agent is left blank, to allow this redirect to any Browser requesting this URL.

Each redirect allows to set a Redirect Response according to the HTML specification, you may select any of the available Redirect Response options. The typical and default is the 301 - Moved Permanently response.

Published allows to set the Published Status of this redirect. All Published redirects are actively used by the extension. To temporarily disable a Redirect, you may set Published to No.

URL-Redirecter records each hit of a individual redirect, to allow monitoring of the Redirects in term of their usage. Using Reset Hits with Save allows to reset the hits counter when saving the edited redirect.


Meaning

Perform the Regular Expression Match /lang-[a-zA-Z]+/ to any incoming URL Request

-> and with a Match found redirect to the Article named 'What Languages are supported...'

-> with using a '301 - Moved Permanently" server response.

All requests to 'http://my.supersite.tld/joomla-15/lang-...' will redirect to the selected Article 'What Languages are supported...'



This is similar to the URL Match Request above, with the difference that a Regular Expression is used for determine the match to any incoming URL Request.


Meaning

Redirect any incoming URL Request of '/joomla-15/shop'

-> to the external site 'http://my.supershop.tld'

-> with using a '301 - Moved Permanently" server response.

All requests to 'http://my.supersite.tld/joomla-15/shop' will redirect to the other site 'http://my.supershop.tld'



This is almost equal to the URL Match Request above, with the difference that the target of the redirection is another URL external to your Joomla! installation.


Meaning

Redirect any incoming URL Request of '/joomla-15/'

-> to the site 'http://mysite.tld/firefox'

-> if the User Agent matches the Regular Expression /Firefox/i

-> with using a '301 - Moved Permanently" server response.

All requests to 'http://my.supersite.tld/joomla-15/' will redirect to the site 'http://mysite.tld/firefox'
if the Regular Expression has a match on the User Agent. So in this example all Firefox Browsers will be redirected.



This is almost equal to the URL Match Request above, with the difference that the User Agent identification of the Browser will be matched against the Only for Browser User Agent Regular Expression.

Instead of using a Regular Expression, also a simple match may be used for Only for Browser User Agent. When using a simple match, the redirect will be used if the term is found in the identification of the User Agent:



Concatenating several terms with a colon is supported, as shown in above example. The match of these terms is performed case-insensitive. When working with User Agent dependant redirects, you may find the Debug Feature of URL-Redirecter useful.

To use this feature, you require to have IP Location for Joomla! installed.


Meaning

Redirect any incoming URL Request of '/joomla-15/'

-> to the Article named 'Support and Documentation'

-> if the IP Location is AT-LINZ

-> with using a '301 - Moved Permanently" server response.


Add the Country Code, City and ZIP Code to Only for IP Location for which this redirect shall apply. The order is Country Code - City - Zip Code. Any spaces in the City or ZIP Code will be removed, such that for “New York” you need to use newyork for the entry:

Examples for the IP Location

at
at-linz
at-linz-4020