Module:GetParameters/doc: Difference between revisions
Revision as of 12:29, 10 May 2024
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.
Usage
getParameters
Takes 2 required arguments, frame_args and arg_list. Parses a frame's arguments, returning either the provided named arguments in arg_list if found or the positional parameters instead if not. This is designed to work around the stripping of values that takes place for defined parameters which could be important.
As an example, the calls getParameters({"a","b","c"},{"x","y"}) and getParameters({x="a",y="b",z="c"},{"x","y"}) would both give back {x="a",y="b"}.
getBoolean
Takes 1 required argument boolean_str. Turns the input into a true/false boolean value based on the input. Will error if given anything other than a string or boolean value.
defined
To be invoked from inside a template instead of a module. Determines if a certain parameter is defined in the parent frame's arguments.
See also