Commit b28ce3b0 authored by Dries's avatar Dries
Browse files

- Patch #62419 by Ber: improved and corrected the PHPdoc of l().

parent 5b3f4237
...@@ -1053,8 +1053,13 @@ function drupal_attributes($attributes = array()) { ...@@ -1053,8 +1053,13 @@ function drupal_attributes($attributes = array()) {
* @param $text * @param $text
* The text to be enclosed with the anchor tag. * The text to be enclosed with the anchor tag.
* @param $path * @param $path
* The Drupal path being linked to, such as "admin/node". Note, this must be a * The Drupal path being linked to, such as "admin/node". Can be an external
* system URL as the url() function will generate the alias. * or internal URL.
* - If you provide the full URL, it will be considered an
* external URL.
* - If you provide only the path (e.g. "admin/node"), it is considered an
* internal link. In this case, it must be a system URL as the url() function
* will generate the alias.
* @param $attributes * @param $attributes
* An associative array of HTML attributes to apply to the anchor tag. * An associative array of HTML attributes to apply to the anchor tag.
* @param $query * @param $query
...@@ -1063,9 +1068,12 @@ function drupal_attributes($attributes = array()) { ...@@ -1063,9 +1068,12 @@ function drupal_attributes($attributes = array()) {
* A fragment identifier (named anchor) to append to the link. * A fragment identifier (named anchor) to append to the link.
* @param $absolute * @param $absolute
* Whether to force the output to be an absolute link (beginning with http:). * Whether to force the output to be an absolute link (beginning with http:).
* Useful for links that will be displayed outside the site, such as in an RSS feed. * Useful for links that will be displayed outside the site, such as in an RSS
* feed.
* @param $html * @param $html
* Whether the title is HTML, or just plain-text. * Whether the title is HTML, or just plain-text. For example for making an
* image a link, this must be set to TRUE, or else you will see the encoded
* HTML.
* @return * @return
* an HTML string containing a link to the given path. * an HTML string containing a link to the given 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