Commit 9af602fe authored by Dries's avatar Dries

- Patch #432864 by mcrittenden, franskuipers: improved documentation for base_path().

parent 3fe4c4e1
......@@ -1938,8 +1938,18 @@ function drupal_get_path($type, $name) {
}
/**
* Returns the base URL path of the Drupal installation.
* At the very least, this will always default to /.
* Returns the base URL path of the Drupal installation, i.e.,
* the directory where Drupal is installed. At the very least,
* this will return "/".
*
* NOTE: base_path prefixes and suffixes a "/" onto the returned
* path if the path is not empty. See examples below.
*
* Example #1: Drupal installed at "http://yoursite.com" means
* this will just return "/" because the path is empty.
*
* Example #2: Drupal installed at "http://yoursite.com/drupal/folder"
* means this function will return "/drupal/folder/".
*/
function base_path() {
return $GLOBALS['base_path'];
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment