Issue #1837840 by amontero: Add clarification to l() function docs
authorJennifer Hodgdon
Mon, 26 Nov 2012 21:00:12 +0000 (13:00 -0800)
committerJennifer Hodgdon
Mon, 26 Nov 2012 21:00:12 +0000 (13:00 -0800)
includes/common.inc

index cd694fd..ea353d1 100644 (file)
@@ -1596,6 +1596,14 @@ function drupal_attributes($attributes = array()) {
  * internal links output by modules should be generated by this function if
  * possible.
  *
+ * However, for links enclosed in translatable text you should use t() and
+ * embed the HTML anchor tag directly in the translated string. For example:
+ * @code
+ * t('Visit the <a href="@url">settings</a> page', array('@url' => url('admin')));
+ * @endcode
+ * This keeps the context of the link title ('settings' in the example) for
+ * translators.
+ *
  * @param $text
  *   The link text for the anchor tag.
  * @param $path