编辑“︁模块:String/doc”︁（章节）

== match ==

此函数从源字符串返回一个匹配指定模式的子字符串。

用法：

: <code><nowiki>{{#invoke:</nowiki>String-{}-|match|''源字符串''|''模式字符串''|''开始索引''|''匹配数量''|''纯标记''|''无匹配输出''}}</code>

或者

: <code><nowiki>{{#invoke:</nowiki>String|-{}-match|s= ''源字符串'' |pattern= ''模式字符串'' |start= ''开始索引''|match= ''匹配数量''|plain= ''纯标记'' |nomatch= ''无匹配输出'' }}</code>

参数：

; s
: 在这个字符串内搜索
; pattern
: 需要在字符串内搜索的模式或者字符串
; start
: 源字符串内的索引，从此索引开始搜索。字符串的第一个字符的索引为1。默认为1。
; match
: 在一些情况下，可能需要在单个字符串中进行多次匹配。此参数指定了返回哪一个匹配，其中第一个匹配就是match=1。如果指定了负数，那么返回的匹配从最后一个匹配开始数的。因此match=-1表达返回最后一个匹配。默认为1。
; plain
: pattern是否应该理解为纯字符串，而非正则表达式。默认为false。
; nomatch
: 如果没有找到匹配，返回nomatch的值，而不是一个错误。

如果match_number或start_index超出了查询的字符串的范围，此函数会产生错误。如果没有找到匹配，也会产生错误。

如果添加了参数ignore_errors=true，那么错误会被禁止，失败时返回的是一个空字符串。

匹配是Lua的一种正则表达式，更多信息可以参考：

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

示例：
* <code><nowiki>{{#invoke:String|match| abc123def456 |%d+}}</nowiki></code> → {{#invoke:String|match| abc123def456 |%d+}}
* <code><nowiki>{{#invoke:String|match|s= abc123def456 |pattern= %d+ }}</nowiki></code> → {{#invoke:String|match|s= abc123def456 |pattern= %d+ }}
* <code><nowiki>{{#invoke:String|match| abc123def456 |%d+|6}}</nowiki></code> → {{#invoke:String|match| abc123def456 |%d+|6}}
* <code><nowiki>{{#invoke:String|match|s= abc123def456 |pattern= %d+ |start= 6 }}</nowiki></code> → {{#invoke:String|match|s= abc123def456 |pattern= %d+ |start= 6 }}
* <code><nowiki>{{#invoke:String|match|s= abc123def456 |pattern= %d+ |start= 6 |match= 2 }}</nowiki></code> → {{#invoke:String|match|s= abc123def456 |pattern= %d+ |start= 6 |match= 2 }}
* <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 }}
* <code><nowiki>{{#invoke:String|match|s= 0012001200 |pattern= 0*(%d*) }}</nowiki></code> → {{#invoke:String|match|s= 0012001200 |pattern= 0*(%d*) }}