Joomla! Documentation™

The "API15" 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.

Description

Returns the root URI for the request.

<! removed transcluded page call, red link never existed >

Syntax

root($pathonly=false, $path=null)

Parameter Name	Default Value	Description
$pathonly	false	$pathonly If false, prepend the scheme, host and port information. Default is false.
$path	null

Returns

string The root URI string

Defined in

libraries/joomla/environment/uri.php

Importing

jimport( 'joomla.environment.uri' );

Source Body

function root($pathonly = false, $path = null)
{
        static $root;

        // Get the scheme
        if(!isset($root))
        {
                $uri            =& JURI::getInstance(JURI::base());
                $root['prefix'] = $uri->toString( array('scheme', 'host', 'port') );
                $root['path']   = rtrim($uri->toString( array('path') ), '/\\');
        }

        // Get the scheme
        if(isset($path)) {
                $root['path']    = $path;
        }

        return $pathonly === false ? $root['prefix'].$root['path'].'/' : $root['path'];
}

<! removed transcluded page call, red link never existed >