SproutCMS

This is the code documentation for the SproutCMS project

function base()

Base URL, with or without the index page.

If protocol is specified, a full URL including the domain will be used
otherwise only the root path will be used

If a subsite-section has a defined URL prefix, it will be added to the URL automatically

Usage

string Url::base ( [ boolean $index [, boolean $protocol ]] );

Arguments

  1. boolean $index = FALSE
    include the index page
  2. boolean $protocol = FALSE
    non-default protocol

Return value

  • string