hook_help documentation has incorrect example code [#529316]

Return value example for hook_help at http://api.drupal.org/api/function/hook_help reads:

$output .= 'A role defines a group of users that have certain privileges as defined in %permission.'; 
$output = t($output, array('%permission' => l(t('user permissions'), 'admin/user/permission')));

Which will not output the link in the text correctly. In accordance with the documentation for t(), it should read:

$output .= 'A role defines a group of users that have certain privileges as defined in !permission.'; 
$output = t($output, array('!permission' => l(t('user permissions'), 'admin/user/permission')));

In order for the link to be rendered as markup rather than plain text.

Comment	File	Size	Author
#4	529316b.patch	5.61 KB	jhodgdon
#4
#1	529316.patch	5.91 KB	jhodgdon
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 5 August 2009 at 14:58

Version:	6.13	» 7.x-dev
Status:	Active	» Needs review

File	Size
529316.patch	5.91 KB

Good point, but actually I don't think that example is very good at all, and I'm not sure an example of how to use t() is really needed there, since the body of hook_help() below has examples.

And there are some other issues with the doc for that hook, which hasn't been modified substantially since Drupal 4.6 at least! Here's a try at cleaning it up.

Comment #2

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 5 August 2009 at 14:59

Just as another note, if someone thinks an example is useful in the return value, it shouldn't have $object being passed into t(), but rather the string directly, as the translation template extractor will not work correctly with a variable passed into t(). On the whole, that example was very bad!!