getOwners: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
||
| Line 1: | Line 1: | ||
= | {{MacroFunction | ||
|name=getOwners | |||
|description=Returns a string list containing the names of the owners of the [[Current Token|Current Token]]. The type of the value returned depends on the delimiter parameter. | |||
Returns a string list containing the names of the owners of the [[ | * If the delimiter is not specified then a [[String List|string list]] is returned with the default value of {{code|","}} is used. | ||
* If the delimiter is not specified then a [[ | * If the delimiter {{code|json}} then a [[JSON Array|json array]] is returned. | ||
* If the delimiter | * Otherwise a [[String List|string list]] is returned with the delimiter passed in. | ||
* Otherwise a [[ | |||
|usage= | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: names = getOwners()] | [h: names = getOwners()] | ||
[h: names = getOwners(delim)] | [h: names = getOwners(delim)] | ||
</source> | </source> | ||
delim is the delimiter used to separate the values in the [[ | {{code|delim}} is the delimiter used to separate the values in the [[String List|string list]] which defaults to {{code|",""}} if not specified. | ||
|example= | |||
To display the [[Owners|owners]] of the current [[Token|token]] use. | |||
To display the [[ | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: names = getOwners()] | [h: names = getOwners()] | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</source> | </source> | ||
|changes= | |||
* '''1.3b49''' - Added {{code|json}} delimiter option. | |||
|also= | |||
[[foreach|foreach()]] | |||
}} | |||
[[Category:Token Function]] | |||
Revision as of 03:02, 8 March 2009
getOwners() Function
Returns a string list containing the names of the owners of the Current Token. The type of the value returned depends on the delimiter parameter.
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
Usage
[h: names = getOwners()]
[h: names = getOwners(delim)]delim is the delimiter used to separate the values in the string list which defaults to ","" if not specified.
Example
To display the owners of the current token use.
[h: names = getOwners()]
[foreach(name, names, "<br>"): name]See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option.