Module:If any equal/doc

This is a documentation subpage for Module:If any equal.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 243,000 pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

Main

This main function of this module checks all positional parameters to see if any of them is equal to the parameter |value=. If so, it will output "yes", otherwise "no".

If the plural |values= is used, then one or more alternative values may be specified.

Examples

{{#invoke:If any equal|main|a|b|c|d|value=c}} gives yes
{{#invoke:If any equal|main|a|b|c|d|value=r}} gives no
{{#invoke:If any equal|main|a|b|c|d|value=}} gives no
{{#invoke:If any equal|main|a|b|c|d|values=r, b}} gives yes

IfAnyEqual

The IfAnyEqual function works in a similar way, but instead takes the names of the parameters and checks these arguments of the parent frame.

Example

For example, if you have the following code on {{Template}}

{{#invoke:If any equal|IfAnyEqual|param1|param2|values=a, b, c}}

Then calling {{Template}} will give the following results:

{{Template|param1=b|param2=f}} gives "yes"
{{Template|param1=z|param2=k}} gives "no"
{{Template|param2=a}} gives "yes"

Using a prefix

If a prefix is specified with |prefix= then the module will check any parameter that consists of that prefix and possibly a number afterwards.

Example

For example, if you have the following code on {{Template}}

{{#invoke:If any equal|IfAnyEqual|prefix=param|values=a, b, c}}

Then calling {{Template}} will give the following results:

{{Template|param=b|param2=f}} gives "yes"
{{Template|param1=z|param3=k}} gives "no"
{{Template|param12=a}} gives "yes"