https://elite.mistflux.co.uk/w/index.php?action=history&feed=atom&title=Module%3ATemplate_parameter_value%2Fdoc 2026-10-31T22:43:06Z Revision history for this page on the wiki MediaWiki 1.46.2 https://elite.mistflux.co.uk/w/index.php?title=Module:Template_parameter_value/doc&diff=112247&oldid=prev 2025-04-16T17:15:29Z

<p><span class="autocomment">getParameter: </span> Set to -1 for last occurrence.</p> <p><b>New page</b></p><div>{{high risk}}<br /> {{lua|Module:Wikitext Parsing}}<br /> Implements {{tl|Template parameter value}} and {{tl|HasTemplate}}, and can be used from other modules.<br /> <br /> == Module functions ==<br /> === getParameter ===<br /> getParameter takes 4 arguments: The page name (string), the template/s (string or table of strings), the parameter (string), and an optional options table. It will return either &lt;code&gt;true&lt;/code&gt; and the contents of the requested parameter or &lt;code&gt;false&lt;/code&gt; and a reason for failure.<br /> <br /> The following options are available:<br /> * &#039;&#039;&#039;template_index&#039;&#039;&#039;: Which occurrence of the template to look for the parameter in. Set to -1 for last occurrence. (default: 1)<br /> * &#039;&#039;&#039;parameter_index&#039;&#039;&#039;: Which occurrence of the parameter to look for (default: 1; only applies when &lt;code&gt;ignore_subtemplates&lt;/code&gt; is false)<br /> * &#039;&#039;&#039;ignore_subtemplates&#039;&#039;&#039;: If parameters should only be searched for in the top-level template, ignoring the parameters in subtemplates (default: false)<br /> * &#039;&#039;&#039;only_subtemplates&#039;&#039;&#039;: If parameters should only be searched for in subtemplates of the top-level template (default: false)<br /> * &#039;&#039;&#039;ignore_blank&#039;&#039;&#039;: Whether or not blank values should count towards &lt;code&gt;parameter_index&lt;/code&gt; (default: false)<br /> * &#039;&#039;&#039;treat_as_regex&#039;&#039;&#039;: Whether or not the template string(s) should be treated as a lua regex (default: false)<br /> <br /> === getTemplate ===<br /> getTemplate takes 3 arguments: The page name (string), the template/s (string or table of strings), and an optional options table. It will return either &lt;code&gt;true&lt;/code&gt; and the text of the requested template or &lt;code&gt;false&lt;/code&gt; and a reason for failure.<br /> <br /> getTemplate supports the options &lt;code&gt;template_index&lt;/code&gt; and &lt;code&gt;treat_as_regex&lt;/code&gt; from getParameter.<br /> <br /> === Helper functions ===<br /> The module exposes some of the helper functions used (&lt;code&gt;matchAllTemplates&lt;/code&gt;, &lt;code&gt;getParameters&lt;/code&gt;, and &lt;code&gt;getAllParameters&lt;/code&gt;) for convenience. Each function has some comments above it in the code explaining its rough purpose.<br /> <br /> == Template functions ==<br /> &lt;code&gt;main&lt;/code&gt; implements {{tl|Template parameter value}} and acts as a template wrapper for &lt;code&gt;getParameter&lt;/code&gt;.<br /> <br /> &lt;code&gt;hasTemplate&lt;/code&gt; implements {{tl|HasTemplate}} and somewhat acts as a wrapper for &lt;code&gt;getTemplate&lt;/code&gt; (it only provides if the template was found, not the template text itself).<br /> <br /> == Testcases ==<br /> Testcases are available at [[Module talk:Template parameter value/testcases]]</div>

Wikipedia>Ahecht