Module:String/doc: Difference between revisions

Revision as of 00:06, 8 May 2020

Latest revision as of 23:52, 11 August 2025

(54 intermediate revisions by 28 users not shown)

Line 1:

<noinclude>

</noinclude>{{High-risk|6332978}}

{{Used in system}}

{{Module rating|protected}}

{{cascade-protected template|page=module}}

{{Tfm/dated|page=String/doc|otherpage=HTMLDecode|link=Wikipedia:Templates for discussion/Log/2020 May 8#Module:String|type=module|bigbox=yes}}

{{Lmd|String}}

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 ==

Line 15 ⟶ 13:

: 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 {{clc|Errors reported by Module String}}.

; no_category

: If set to 'true' or 1, no category will be added if an error is generated.

Line 45 ⟶ 43:

== sub ==

This function returns a substring of the target string at specified inclusive, one-indexed indices.

Usage:

Line 64 ⟶ 62:

: 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. To avoid error messages, use {{ml|ustring|sub}} instead.

Examples:

Line 119 ⟶ 117:

: The pattern or string to find within the string

; start

: The index within the source string to start the search. The first character of the string has index 1. Defaults to 1.

; 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.

; 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 [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]). Defaults to false (to change: <code>plain=true</code>)

; nomatch

: If no match is found, output the "nomatch" value rather than an error.

Line 129 ⟶ 127:

: 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 ignore_errors=true, then the error will be suppressed and an empty string will be returned on any failure.

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

* [[mw:Special:MyLanguage/Extension:Scribunto/Lua_reference_manualLua reference manual#Patterns|Scribunto patterns]]

* [[mw:Special:MyLanguage/Extension:Scribunto/Lua_reference_manualLua reference manual#Ustring_patternsUstring patterns|Scribunto Unicode string patterns]]

Examples:

Line 145 ⟶ 143:

* <code><nowiki>{{#invoke:String|match|s= abc123%d+ |pattern= %d+ }}</nowiki></code> → {{#invoke:String|match|s= abc123%d+ |pattern= %d+ }}

* <code><nowiki>{{#invoke:String|match|s= abc123%d+ |pattern= %d+ |plain= true }}</nowiki></code> → {{#invoke:String|match|s= abc123%d+ |pattern= %d+ |plain= true }}

* <code><nowiki>{{#invoke:String|match|s= abc |pattern= %d }}</nowiki></code> → {{#invoke:String|match|s= abc |pattern= %d |no_category=true}}

* <code><nowiki>{{#invoke:String|match|s= abc |pattern= %d |nomatch= No numeric characters in string }}</nowiki></code> → {{#invoke:String|match|s= abc |pattern= %d |nomatch= No numeric characters in string }}

* <code><nowiki>{{#invoke:String|match|s= abc |pattern= %d |ignore_errors= true }}</nowiki></code> → {{#invoke:String|match|s= abc |pattern= %d |ignore_errors= true }}

Line 172 ⟶ 170:

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.

Line 183 ⟶ 181:

== str_find ==

This function duplicates the behavior of {{tl|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.

Line 191 ⟶ 189:

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|findstr_find|''source_string''|''target_string''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|findstr_find|source= ''source_string'' |target= ''target_string'' }}</code>

Parameters:

Line 209 ⟶ 207:

* <code><nowiki>{{#invoke:String|str_find| abc123def |123}}</nowiki></code> → {{#invoke:String|str_find| abc123def |123}}

* <code><nowiki>{{#invoke:String|str_find|source= abc123def |target= 123 }}</nowiki></code> → {{#invoke:String|str_find|source= abc123def |target= 123 }}

* <code><nowiki>{{#invoke:String|str_find| abc123def |not}}</nowiki></code> → {{#invoke:String|str_find| abc123def |not}}

== find ==

Line 231 ⟶ 230:

: The index within the source string to start the search, defaults to 1

; 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 [[w:en:Lua (programming language)|Lua]]-style [[w:en: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.

Line 239 ⟶ 238:

Examples:

* <code><nowiki>{{#invoke:String|find|abc123def|12}}</nowiki></code> → {{#invoke:String|find|abc123def|12}}

* <code><nowiki>{{#invoke:String|find|source=abc123def|target=12}}</nowiki></code> → {{#invoke:String|find|source=abc123def|target=12}}

* <code><nowiki>{{#invoke:String|find|source=abc123def|target=pqr}}</nowiki></code> → {{#invoke:String|find|source=abc123def|target=pqr}}

* <code><nowiki>{{#invoke:String|find| abc123def |123}}</nowiki></code> → {{#invoke:String|find| abc123def |123}}

* <code><nowiki>{{#invoke:String|find|source= abc123def |target= 123 }}</nowiki></code> → {{#invoke:String|find|source= abc123def |target= 123 }}

Line 251 ⟶ 247:

* <code><nowiki>{{#invoke:String|find| abc123def |c|false}}</nowiki></code> → {{#invoke:String|find| abc123def |c|false}}

* <code><nowiki>{{#invoke:String|find|source= abc123def |target=c|plain=false}}</nowiki></code> → {{#invoke:String|find|source= abc123def |target=c|plain=false}}

* <code><nowiki>{{#invoke:string|find|abc 123 def|%s|plain=false}}</nowiki></code> → {{#invoke:string|find|abc 123 def|%s|plain=false}}

Testing for the presence of a string:

== replace ==

* <code>{{pf|ifexpr|<nowiki>{{#invoke:string|find|haystack|needle}}</nowiki>|Found needle|Didn't find needle}}</code> → {{#ifexpr:{{#invoke:string|find|haystack|needle}}|Found needle|Didn't find needle}}

=== findpagetext ===

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

The findpagetext function returns the position of a piece of text in the wikitext source of a page. It takes up to four parameters:

* First positional parameter or |text is the text to be searched for.

* Optional parameter |title is the page title, defaults to the current page.

* Optional parameter |plain is either true for a plain search (default), or false for a [[mw:Extension:Scribunto/Lua reference manual #Patterns|Lua pattern]] search.

* Optional parameter |nomatch is the value returned when no match is found; default is nothing.

; Examples

: <code><nowiki>{{#invoke:String |findpagetext |text=Youghiogheny}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=Youghiogheny}}

: <code><nowiki>{{#invoke:String |findpagetext |text=Youghiogheny |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=Youghiogheny |nomatch=not found}}

: <code><nowiki>{{#invoke:String |findpagetext |text=Youghiogheny |title=Boston Bridge |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=Youghiogheny |title=Boston Bridge |nomatch=not found}}

: <code><nowiki>{{#invoke:String |findpagetext |text=river |title=Boston Bridge |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=river |title=Boston Bridge |nomatch=not found}}

: <code><nowiki>{{#invoke:String |findpagetext |text=[Rr]iver |title=Boston Bridge |plain=false |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=[Rr]iver |title=Boston Bridge |plain=false |nomatch=not found}}

: <code><nowiki>{{#invoke:String |findpagetext |text=%[%[ |title=Boston Bridge |plain=f |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=%[%[ |title=Boston Bridge |plain=f |nomatch=not found}}

: <code><nowiki>{{#invoke:String |findpagetext |text=%{%{[Cc]oord |title=Boston Bridge |plain=f |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=%{%{coord |title=Boston Bridge |plain=f |nomatch=not found}}

The search is case-sensitive, so Lua pattern matching is needed to find <code>river</code> or <code>River</code>. The last example finds <code><nowiki>{{coord</nowiki></code> and <code><nowiki>{{Coord</nowiki></code>. The penultimate example finds a wiki-link.

The [[Template:Findpagetext]] is a convenience wrapper for this function.

{{anchor|replace}}

== 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>[[mw:Extension:Scribunto/Lua_reference_manual#mw.ustring.gsub|mw.ustring.gsub]]</code>.

Usage:

Line 275 ⟶ 298:

: The number of occurrences to replace; defaults to all

; 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 [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]); defaults to true

Examples:

* <code><nowiki>"{{#invoke:String|replace| abc123def456 |123|NXYZ}}"</nowiki></code> → "{{#invoke:String|replace| abc123def456 |123|NXYZ}}"

* <code><nowiki>"{{#invoke:String|replace|source= abc123def456 |pattern= 123 |replace= NXYZ }}"</nowiki></code> → "{{#invoke:String|replace|source= abc123def456 |pattern= 123 |replace= NXYZ }}"

* <code><nowiki>"{{#invoke:String|replace| abc123def456 |%d+|NXYZ|1|false}}"</nowiki></code> → "{{#invoke:String|replace| abc123def456 |%d+|NXYZ|1|false}}"

* <code><nowiki>"{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= NXYZ |count=1 |plain= false }}"</nowiki></code> → "{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= NXYZ |count=1 |plain= false }}"

* <code><nowiki>"{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= NXYZ |plain= false }}"</nowiki></code> → "{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= NXYZ |plain= false }}"

* <code><nowiki>{{#invoke:String|replace|source= 0012001200 |pattern= ^0* |plain= false }}</nowiki></code> → {{#invoke:String|replace|source= 0012001200 |pattern= ^0* |plain= false }}

Line 308 ⟶ 331:

== escapePattern ==

Escapes magic characters inIn a [[:mw:LUAREF#Patterns|Lua pattern]]., If you convertchanges a string''class usingcharacter'' this function, then the converted string will be interpreted asinto a ''literal stringcharacter''. inFor functionsexample: thatin accepta Luapattern, patterns. For example,character <code>.</code>, meaningcatches "any character",; escapePattern will beconvert convertedit to <code>%.</code>, meaningcatching just the literal character ".".

Usage:

* <code><nowiki>{{#invoke:String|escapePattern|</nowiki>''pattern_string''<nowiki>}}</nowiki></code>

Line 323 ⟶ 345:

* <code><nowiki>"{{#invoke:String|escapePattern|A.D.}}"</nowiki></code> → "{{#invoke:String|escapePattern|A.D.}}"

* <code><nowiki>"{{#invoke:String|escapePattern|10%}}"</nowiki></code> → "{{#invoke:String|escapePattern|10%}}"

== count ==

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

Usage:

Line 338 ⟶ 361:

: The string or pattern to count occurrences of within source

; 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 [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]); defaults to true

Examples:

* Count of 'a': <code><nowiki>"{{#invoke:String|count|aabbcc|a}}"</nowiki></code> → "{{#invoke:String|count|aabbcc|a}}"

* Count occurrences of 'aba': <code><nowiki>"{{#invoke:String|count|ababababab|aba}}"</nowiki></code> → "{{#invoke:String|count|ababababab|aba}}"

* Count of "either 'a' or 'c' ":<code><nowiki>"{{#invoke:String|count|aabbcc|[ac]|plain=false}}"</nowiki></code> → "{{#invoke:String|count|aabbcc|[ac]|plain=false}}"

* Count of "not 'a' ": <code><nowiki>"{{#invoke:String|count|aaabaaac|[^a]|plain=false}}"</nowiki></code> → "{{#invoke:String|count|aaabaaac|[^a]|plain=false}}"

Line 347 ⟶ 371:

== join ==

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

Usage:

Line 366 ⟶ 390:

== endswith ==

{{for|the startswith function|Module:String2#startswith}}

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|endswith|''source_str''|''pattern_stringsearch_string''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|endswith|source= ''source_string'' |pattern= ''pattern_stringsearch_string''}}</code>

Returns "yes" if the source string ends with the patternsearch string. Use Bothnamed stringsparameters areto have the strings trimmed before use. Despite the parameter name, ''search_string'' is not a Lua pattern, it is interpreted literally.

* <code><nowiki>"{{#invoke:String|endswith|xxxyyy|y}}"</nowiki></code> → "{{#invoke:String|endswith|xxxyyy|y}}"

* <code><nowiki>"{{#invoke:String|endswith|xxxyyy|z}}"</nowiki></code> → "{{#invoke:String|endswith|xxxyyy|z}}"

== See also ==

* {{mfl|Params|mapping_by_replacing}} and other functions from the same module

* [[Module:String2]] for functions to convert the capitalisation of strings to upper, lower, sentence or title case.

* {{mfl|MultiReplace|main}}

* [[Module:StringFunc]]

* [[Module:Ustring]]

{{String handling templates}}

<includeonly>{{Sandbox other||

[[Category:Modules that add a tracking category]]

[[Category:Modules that manipulate strings|*]]

[[Category:Template metamodules]]

}}</includeonly>