View source for Module:String/doc

{{Documentation subpage}}
__NOTOC__

This module is intended to provide access to basic string functions.

Most of the functions provided here can be invoked with named parameters, unnamed parameters, or a mixture.  If named parameters are used, Mediawiki will automatically remove any leading or trailing whitespace from the parameter. Depending on the intended use, it may be advantageous to either preserve or remove such whitespace.

== Global options ==

; ignore_errors : If set to 'true' or 1, any error condition will result in an empty string being returned rather than an error message.
; error_category : If an error occurs, specifies the name of a category to include with the error message.  The default category is {{Cat|Errors reported by Module String}}.
; no_category : If set to 'true' or 1, no category will be added if an error is generated.

Unit tests for this module are available at [[Module:String/testcases]].

== len ==

This function returns the length of the target string.

=== Usage ===
: {{mlc|String|len|''target_string''}}

OR

: {{mlc|String|len|s {{=}} ''target_string''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|s}} || The string whose length to report
|}

=== Examples ===
* {{mlc|String|len| abcdefghi }} {{Rarr}} {{#invoke:String|len| abcdefghi }}
* {{mlc|String|len|s {{=}} abcdefghi }} {{Rarr}} {{#invoke:String|len|s = abcdefghi }}

== sub ==

This function returns a substring of the target string at specified indices.

=== Usage ===
: {{mlc|String|sub|''target_string''|''start_index''|''end_index''}}

OR

: {{mlc|String|sub|s {{=}} ''target_string''|i {{=}} ''start_index''|j {{=}} ''end_index''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|s}} || The string to return a subset of
|-
| {{para|i}} || The first index of the substring to return, defaults to 1.
|-
| {{para|j}} || The last index of the string to return, defaults to the last character.
|}

The first character of the string is assigned an index of 1. If either i or j is a negative value, it is interpreted the same as selecting a character by counting from the end of the string.  Hence, a value of -1 is the same as selecting the last character of the string.

If the requested indices are out of range for the given string, an error is reported.

=== Examples ===
* {{mlc|String|sub| abcdefghi }} {{Rarr}} {{#invoke:String|sub| abcdefghi }}
* {{mlc|String|sub|s {{=}} abcdefghi }} {{Rarr}} {{#invoke:String|sub|s = abcdefghi }}
* {{mlc|String|sub| abcdefghi | 3 }} {{Rarr}} {{#invoke:String|sub| abcdefghi | 3 }}
* {{mlc|String|sub|s {{=}} abcdefghi |i {{=}} 3 }} {{Rarr}} {{#invoke:String|sub|s = abcdefghi |i = 3 }}
* {{mlc|String|sub| abcdefghi | 3 | 4 }} {{Rarr}} {{#invoke:String|sub| abcdefghi | 3 | 4 }}
* {{mlc|String|sub|s {{=}} abcdefghi |i{{=}} 3 |j{{=}} 4 }} {{Rarr}} {{#invoke:String|sub|s = abcdefghi |i = 3 |j = 4 }}

== sublength ==

This function implements the features of {{tls|str sub old}} and is kept in order to maintain these older templates. It returns a substring of the target string starting at a specified index and of a specified length.

=== Usage ===

: {{mlc|String|sublength|s {{=}} ''target_string'' |i {{=}} ''start_index'' |len {{=}} ''length''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|s}} || The string
|-
| {{para|i}} || The starting index of the substring to return. The first character of the string is assigned an index of 0.
|-
| {{para|len}} || The length of the string to return, defaults to the last character.
|}

=== Examples ===
* {{mlc|String|sublength|s {{=}} abcdefghi }} {{Rarr}} {{#invoke:String|sublength|s = abcdefghi}}
* {{mlc|String|sublength|s {{=}} abcdefghi |i {{=}} 3 }} {{Rarr}} {{#invoke:String|sublength|s = abcdefghi|i = 3 }}
* {{mlc|String|sublength|s {{=}} abcdefghi |i {{=}} 3 |len {{=}} 4 }} {{Rarr}} {{#invoke:String|sublength|s = abcdefghi|i = 3 |len = 4 }}

== match ==

This function returns a substring from the source string that matches a specified pattern.

=== Usage ===
: {{mlc|String|match|''source_string''|''pattern_string''|''start_index''|''match_number''|''plain_flag''|''nomatch_output''}}

OR

: {{mlc|String|match|s {{=}} ''source_string'' |pattern {{=}} ''pattern_string'' |start {{=}} ''start_index'' |match {{=}} ''match_number'' |plain {{=}} ''plain_flag'' |nomatch {{=}} ''nomatch_output'' }}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|s}} || The string to search
|-
| {{para|pattern}} || The pattern or string to find within the string
|-
| {{para|start}} || The index within the source string to start the search.  The first character of the string has index 1.  Defaults to 1.
|-
| {{para|match}} || In some cases it may be possible to make multiple matches on a single string.  This specifies which match to return, where the first match is match= 1.  If a negative number is specified then a match is returned counting from the last match.  Hence match = -1 is the same as requesting the last match.  Defaults to 1.
|-
| {{para|plain}} || Boolean flag indicating that pattern should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[Wikipedia:en:Lua (programming language)|Lua]]-style [[Wikipedia:en:regular expression|regular expression]]). Defaults to false (to change: <code>plain=true</code>)
|-
| {{para|nomatch}} || If no match is found, output the "nomatch" value rather than an error.
|-
| {{para|ignore_errors}} || If no match is found and ignore_errors=true, output an empty string rather than an error.
|}

If the match_number or start_index are out of range for the string being queried, then this function generates an error.  An error is also generated if no match is found.
If one adds the parameter {{para|ignore_errors|true}}, then the error will be suppressed and an empty string will be returned on any failure.

For information on constructing [[Wikipedia:en:Lua (programming language)|Lua]] patterns, a form of [[Wikipedia:en:regular expression|regular expression]], see:

* [[mw:Extension:Scribunto/Lua_reference_manual#Patterns|Scribunto patterns]]
* [[mw:Extension:Scribunto/Lua_reference_manual#Ustring_patterns|Scribunto Unicode string patterns]]

=== Examples ===
* {{mlc|String|match| abc123def456 |%d+}} {{Rarr}} {{#invoke:String|match| abc123def456 |%d+}}
* {{mlc|String|match|s{{=}} abc123def456 |pattern{{=}} %d+ }} {{Rarr}} {{#invoke:String|match|s= abc123def456 |pattern= %d+ }}
* {{mlc|String|match| abc123def456 |%d+|6}} {{Rarr}} {{#invoke:String|match| abc123def456 |%d+|6}}
* {{mlc|String|match|s{{=}} abc123def456 |pattern{{=}} %d+ |start{{=}} 6 }} {{Rarr}} {{#invoke:String|match|s= abc123def456 |pattern= %d+ |start= 6 }}
* {{mlc|String|match|s{{=}} abc123def456 |pattern{{=}} %d+ |start{{=}} 6 |match{{=}} 2 }} {{Rarr}} {{#invoke:String|match|s= abc123def456 |pattern= %d+ |start= 6 |match= 2 }}
* {{mlc|String|match|s{{=}} abc123%d+ |pattern{{=}} %d+ }} {{Rarr}} {{#invoke:String|match|s= abc123%d+ |pattern= %d+ }}
* {{mlc|String|match|s{{=}} abc123%d+ |pattern{{=}} %d+ |plain{{=}} true }} {{Rarr}} {{#invoke:String|match|s= abc123%d+ |pattern= %d+ |plain= true }}
* {{mlc|String|match|s{{=}} abc |pattern{{=}} %d }} {{Rarr}} {{#invoke:String|match|s= abc |pattern= %d |no_category=true}}
* {{mlc|String|match|s{{=}} abc |pattern{{=}} %d |nomatch{{=}} No numeric characters in string }} {{Rarr}} {{#invoke:String|match|s= abc |pattern= %d |nomatch= No numeric characters in string }}
* {{mlc|String|match|s{{=}} abc |pattern{{=}} %d |ignore_errors{{=}} true }} {{Rarr}} {{#invoke:String|match|s= abc |pattern= %d |ignore_errors= true }}
* {{mlc|String|match|s{{=}} 0012001200 |pattern{{=}} 0*(%d*) }} {{Rarr}} {{#invoke:String|match|s= 0012001200 |pattern= 0*(%d*) }}

== pos ==

This function returns a single character from the target string at position pos.

=== Usage ===
: {{mlc|String|pos|''target_string''|''index_value''}}

OR

: {{mlc|String|pos|target {{=}} ''target_string'' |pos {{=}} ''index_value''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|target}} || The string to search
|-
| {{para|pos}} || The index for the character to return
|}

The first character has an index value of 1.

If one requests a negative value, this function will select a character by counting backwards
from the end of the string.  In other words pos = -1 is the same as asking for the last character.

A requested value of zero, or a value greater than the length of the string returns an error.

=== Examples ===
* {{mlc|String|pos| abcdefghi | 4 }} {{Rarr}} {{#invoke:String|pos| abcdefghi | 4 }}
* {{mlc|String|pos|target {{=}} abcdefghi |pos {{=}} 4 }} {{Rarr}} {{#invoke:String|pos|target = abcdefghi |pos = 4 }}

== str_find ==

This function duplicates the behavior of {{tls|str_find}}, including all of its quirks. This is provided in order to support existing templates, but is NOT RECOMMENDED for new code and templates.  New code is recommended to use the "find" function instead.

Returns the first index in "source" that is a match to "target".  Indexing is 1-based, and the function returns -1 if the "target" string is not present in "source".

Important Note: If the "target" string is empty / missing, this function returns a value of "1", which is generally unexpected behavior, and must be accounted for separately.

=== Usage ===
: {{mlc|String|find|''source_string''|''target_string''}}

OR

: {{mlc|String|find|source {{=}} ''source_string''|target {{=}} ''target_string''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|source}} || The string to search
|-
| {{para|target}} || The string to find within source
|}

=== Examples ===
* {{mlc|String|str_find| abc123def }} {{Rarr}} {{#invoke:String|str_find| abc123def }}
* {{mlc|String|str_find|source{{=}} abc123def }} {{Rarr}} {{#invoke:String|str_find|source= abc123def }}
* {{mlc|String|str_find| abc123def |123}} {{Rarr}} {{#invoke:String|str_find| abc123def |123}}
* {{mlc|String|str_find|source{{=}} abc123def |target{{=}} 123 }} {{Rarr}} {{#invoke:String|str_find|source= abc123def |target= 123 }}
* {{mlc|String|str_find| abc123def |not}} {{Rarr}} {{#invoke:String|str_find| abc123def |not}}

== find ==

This function allows one to search for a target string or pattern within another string.

=== Usage ===
: {{mlc|String|find|''source_string''|''target_string''|''start_index''|''plain_flag''}}

OR

: {{mlc|String|find|source {{=}} ''source_string''|target {{=}} ''target_string''|start {{=}} ''start_index''|plain {{=}} ''plain_flag''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|source}} || The string to search
|-
| {{para|target}} || The string or pattern to find within source
|-
| {{para|start}} || The index within the source string to start the search, defaults to 1
|-
| {{para|plain}} || Boolean flag indicating that target should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[Wikipedia:Lua (programming language)|Lua]]-style [[Wikipedia:regular expression|regular expression]]); defaults to true
|}

This function returns the first index >= "start" where "target" can be found within "source".  Indices are 1-based.  If "target" is not found, then this function returns 0.  If either "source" or "target" are missing / empty, this function also returns 0.

This function should be safe for UTF-8 strings.

=== Examples ===
* {{mlc|String|find|abc123def|12}} {{Rarr}} {{#invoke:String|find|abc123def|12}}

* {{mlc|String|find|source{{=}}abc123def|target{{=}}12}} {{Rarr}} {{#invoke:String|find|source=abc123def|target=12}}

* {{mlc|String|find|source{{=}}abc123def|target{{=}}pqr}} {{Rarr}} {{#invoke:String|find|source=abc123def|target=pqr}}

* {{mlc|String|find| abc123def |123}} {{Rarr}} {{#invoke:String|find| abc123def |123}}
* {{mlc|String|find|source{{=}} abc123def |target{{=}} 123 }} {{Rarr}} {{#invoke:String|find|source= abc123def |target= 123 }}
* {{mlc|String|find|source{{=}}abc123def|target{{=}}%d |start{{=}}3 |plain{{=}}false }} {{Rarr}} {{#invoke:String|find|source=abc123def|target=%d |start=3 |plain=false }}

When using unnamed parameters, preceding and trailing spaces are kept and counted:
* {{mlc|String|find|  abc123def |c|false}} {{Rarr}} {{#invoke:String|find|  abc123def |c|false}}
* {{mlc|String|find|source{{=}}  abc123def |target{{=}}c|plain{{=}}false}} {{Rarr}} {{#invoke:String|find|source=  abc123def |target=c|plain=false}}
* {{mlc|string|find|abc 123 def|%s|plain{{=}}false}} {{Rarr}} {{#invoke:string|find|abc 123 def|%s|plain=false}}

== replace (gsub) ==

This function allows one to replace a target string or pattern within another string. To Lua programmers: this function works internally by calling <code>string.gsub</code>.

=== Usage ===
: {{mlc|String|replace|''source_str''|''pattern_string''|''replace_string''|''replacement_count''|''plain_flag''}}

OR

: {{mlc|String|replace|source {{=}} ''source_string''|pattern {{=}} ''pattern_string''|replace {{=}} ''replace_string''|count {{=}} ''replacement_count''|plain {{=}} ''plain_flag''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|source}} || The string to search
|-
| {{para|pattern}} || The string or pattern to find within source
|-
| {{para|replace}} || The replacement text
|-
| {{para|count}} || The number of occurrences to replace; defaults to all
|-
| {{para|plain}} || Boolean flag indicating that pattern should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[Wikipedia:Lua (programming language)|Lua]]-style [[Wikipedia:regular expression|regular expression]]); defaults to true
|}

=== Examples ===
* {{mlc|String|replace| abc123def456 |123|XYZ}} {{Rarr}} "{{#invoke:String|replace| abc123def456 |123|XYZ}}"
* {{mlc|String|replace|source{{=}} abc123def456 |pattern{{=}} 123 |replace{{=}} XYZ }} {{Rarr}} "{{#invoke:String|replace|source= abc123def456 |pattern= 123 |replace= XYZ }}"
* {{mlc|String|replace| abc123def456 |%d+|XYZ|1|false}} {{Rarr}} "{{#invoke:String|replace| abc123def456 |%d+|XYZ|1|false}}"
* {{mlc|String|replace|source{{=}} abc123def456 |pattern{{=}} %d+ |replace{{=}} XYZ |count{{=}}1 |plain{{=}} false }} {{Rarr}} "{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= XYZ |count=1 |plain= false }}"
* {{mlc|String|replace|source{{=}} abc123def456 |pattern{{=}} %d+ |replace{{=}} XYZ |plain{{=}} false }} {{Rarr}} "{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= XYZ |plain= false }}"
* {{mlc|String|replace|source{{=}} 0012001200 |pattern{{=}} ^0* |plain{{=}} false }}</code> {{Rarr}} {{#invoke:String|replace|source= 0012001200 |pattern= ^0* |plain= false }}

== rep ==

Repeats a string ''n'' times. A simple function to pipe string.rep to templates.

=== Usage ===
: {{mlc|String|rep|''source''|''count''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|source}} || The string to repeat
|-
| {{para|count}} || The number of repetitions.
|}

=== Examples ===
* {{mlc|String|rep|hello|3}} {{Rarr}} {{#invoke:String|rep|hello|3}}
* {{mlc|String|rep| hello| 3 }} {{Rarr}} {{#invoke:String|rep| hello | 3 }}

== escapePattern ==

Escapes magic characters in a [[mw:LUAREF#Patterns|Lua pattern]]. If you convert a string using this function, then the converted string will be interpreted as a literal string in functions that accept Lua patterns. For example, <code>.</code>, meaning "any character", will be converted to <code>%.</code>, meaning the literal character ".".

=== Usage ===
:  {{mlc|String|escapePattern|''pattern_string''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|pattern_string}} || The pattern string to escape
|}

=== Examples ===
* {{mlc|String|escapePattern|A.D.}} {{Rarr}} {{#invoke:String|escapePattern|A.D.}}
* {{mlc|String|escapePattern|10%}} {{Rarr}} {{#invoke:String|escapePattern|10%}}

== count == 

Counts the number of times a given pattern appears in the arguments that get passed on to this module. 

=== Usage ===
: {{mlc|String|count|''source_str''|''pattern_string''|''plain_flag''}}

OR

: {{mlc|String|count|source = ''source_string''|pattern = ''pattern_string''|plain = ''plain_flag''}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|source_string}} || The string to count occurrences in
|-
| {{para|pattern}} || The string or pattern to count occurrences of within source
|-
|{{para| plain}} || Boolean flag indicating that pattern should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[Wikipedia:en:Lua (programming language)|Lua]]-style [[Wikipedia:en:regular expression|regular expression]]); defaults to true
|}

=== Examples ===
* Count of 'a'
: {{mlc|String|count|aabbcc|a}} {{Rarr}} {{#invoke:String|count|aabbcc|a}}
* Count of "either 'a' or 'c' 
: {{mlc|String|count|aabbcc|[ac]|plain {{=}} false}} {{Rarr}} {{#invoke:String|count|aabbcc|[ac]|plain=false}}
* Count of "not 'a' 
: {{mlc|String|count|aaabaaac|[^a]|plain {{=}} false}} {{Rarr}} {{#invoke:String|count|aaabaaac|[^a]|plain = false}}"
* Count of "starts with 'a' 
: {{mlc|String|count|aaabaaac|^a|plain {{=}} false}} {{Rarr}} {{#invoke:String|count|aaabaaac|^a|plain = false}}

== join ==

Joins all strings passed as arguments into one string, treating the first argument as a separator

=== Usage ===
: {{mlc|String|join|''separator''|''string1''|''string2''|...}}

=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| {{para|separator}} || String that separates each string being joined together (Note that leading and trailing spaces are ''not'' stripped from the separator.)
|-
| {{para|string1}} {{para|string2}} ... || Strings being joined together
|}

=== Examples ===
* {{mlc|String|join|x|foo|bar|baz}} {{Rarr}} {{#invoke:String|join|x|foo|bar|baz}}
* {{mlc|String|join||a|b|c|d|e|f|g}} {{Rarr}} {{#invoke:String|join||a|b|c|d|e|f|g}}
* {{mlc|String|join|,|a|b|c|d|e|f|g}} {{Rarr}} {{#invoke:String|join|,|a|b|c|d|e|f|g}}
* {{mlc|String|join|, |a|b|c|d|e|f|g}} {{Rarr}} {{#invoke:String|join|, |a|b|c|d|e|f|g}}
* {{mlc|String|join|&ndash;|a|b|c|d|e|f|g}} {{Rarr}} {{#invoke:String|join|&ndash;|a|b|c|d|e|f|g}}
The preceding example uses the html entity &amp;ndash; but the unicode character also works.

== endswith ==
=== Usage ===
: {{mlc|String|endswith|''source_str''|''pattern_string''}}

OR

: {{mlc|String|endswith|source {{=}} ''source_string''|pattern {{=}} ''pattern_string''}}

Returns "yes" if the source string ends with the pattern string.  Both strings are trimmed before use.

=== Examples ===
* {{mlc|String|endswith|xxxyyy|y}} {{Rarr}} {{#invoke:String|endswith|xxxyyy|y}}
* {{mlc|String|endswith|xxxyyy|z}} {{Rarr}} {{#invoke:String|endswith|xxxyyy|z}}

<includeonly>{{sandbox other||{{testcases other||

<!-- Categories below this line, please -->
[[Category:Modules]]
[[Category:Modules that add a tracking category]]
}}}}</includeonly>