Joomla! Documentation™

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JRoute::_

Description

Translates an internal Joomla URL to a humanly readible URL.

Synopsis

public static JRoute::_ ($url, $xhtml=true, $ssl=null)

Parameter	Type	Default	Description
$url	string		Absolute or Relative URI to Joomla resource.
$xhtml	boolean	true	Replace & by & for xml compilance.
$ssl	int	null	Secure state for the resolved URI. 1: Make URI secure using global secure site URI. 0: Leave URI in the same secure state as it was passed to the function. -1: Make URI unsecure using the global unsecure site URI.

Returns

The translated humanly readible URL.

Defined in

libraries/joomla/methods.php

Referenced by

• JPagination::_buildDataObject
• JControllerForm::add
• JControllerForm::cancel
• JControllerAdmin::checkin
• JRequest::checkToken
• JControllerAdmin::delete
• JControllerForm::edit
• JControllerAdmin::publish
• JDocumentRendererRSS::render
• JDocumentRendererAtom::render
• JControllerAdmin::reorder
• JControllerForm::save
• JControllerAdmin::saveorder

See also

• JRoute
• Other versions of this method

Examples

<CodeExamplesForm />