Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix docs for the HtmlPageLinkRenderer hooks

Browse source 
The $text parameter wasn't correctly documented here,
as far as I can tell.

Change-Id: I335d1a59739d80f9f904872e3135f0aae7535956
This commit is contained in:
Marius Hoch 2016-08-26 03:58:59 +02:00 committed by Kunal Mehta
parent 2dd09869c9
commit 4858ae0ce1
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/hooks.txt
View file

@ -1937,8 +1937,8 @@ LinkRenderer, before processing starts. Return false to skip default
processing and return $ret.
$linkRenderer: the LinkRenderer object
$target: the LinkTarget that the link is pointing to
&$html: the contents that the <a> tag should have (raw HTML); null means
"default".
&$text: the contents that the <a> tag should have; either a plain, unescaped
string or a HtmlArmor object; null means "default".
&$customAttribs: the HTML attributes that the <a> tag should have, in
associative array form, with keys and values unescaped. Should be merged
with default values, with a value of false meaning to suppress the
@ -1955,7 +1955,8 @@ return false, $ret will be returned.
$linkRenderer: the LinkRenderer object
$target: the LinkTarget object that the link is pointing to
$isKnown: boolean indicating whether the page is known or not
&$html: the final (raw HTML) contents of the <a> tag, after processing.
&$text: the contents that the <a> tag should have; either a plain, unescaped
string or a HtmlArmor object.
&$attribs: the final HTML attributes of the <a> tag, after processing, in
associative array form.
&$ret: the value to return if your hook returns false.