Template:In string/doc

This template wraps the function {{#invoke:String|find|...}}, and provides the extra option to return an alternative string (including a blank string) when nothing is found.

Usage

{{In string|source_string|target_string|start_index|plain_flag|nomatch_returntext}}

or

{{In string|source=source_string |target=target_string |start=start_index |plain=plain_flag |nomatch=nomatch_returntext}}

{{In_string
|source= 
|target= 
|start= 
|plain=
|nomatch=
}}

By default, when the target is not found, 0 is returned.

Set |nomatch=anytext to replace that 0. Also, |nomatch= <blank> returns blank not 0.

Note: outer spaces are not conserved.

Using the nomatch option

{{#if:{{in string|source=pancake|target=pizza|plain=true|nomatch=}}|Is a pizza|Not a pizza}} → Not a pizza

{{#if:{{in string|source=Hawaiian pizza|target=pizza|plain=true|nomatch=}}|Is a pizza|Not a pizza}} → Is a pizza

Examples

• {{In string|abc123def }} → 0
• {{In string|source= abc123def }} → 0
• {{In string|abc123def |123}} → 4
• {{In string|source= abc123def |target= 123 }} → 4
• {{In string|abc123def |%d|3|false}} → 4
• {{In string|source= abc123def |target= %d |start= 3 |plain= false }} → 4

nomatch=xxx

• {{In string|abc123def |nomatch=xxx}} → xxx
• {{In string|source= abc123def |nomatch=xxx}} → xxx
• {{In string|abc123def |123|nomatch=xxx}} → 4
• {{In string|source= abc123def |target= 123 |nomatch=xxx}} → 4
• {{In string|abc123def |%d|3|false|nomatch=xxx}} → 4
• {{In string|source= abc123def |target= %d |start= 3 |plain= false |nomatch=xxx}} → 4

nomatch = blank

• {{In string|abc123def |nomatch=}} →
• {{In string|source= abc123def |nomatch=}} →
• {{In string|abc123def |123|nomatch=}} → 4
• {{In string|source= abc123def |target= 123 |nomatch=}} → 4
• {{In string|abc123def |%d|3|false|nomatch=}} → 4
• {{In string|source= abc123def |target= %d |start= 3 |plain= false |nomatch=}} → 4

module Examples

• {{#invoke:String|find|abc123def }} → 0
• {{#invoke:String|find|source= abc123def }} → 0
• {{#invoke:String|find|abc123def |123}} → 4
• {{#invoke:String|find|source= abc123def |target= 123 }} → 4
• {{#invoke:String|find|abc123def |%d|3|false}} → 4
• {{#invoke:String|find|source= abc123def |target= %d |start= 3 |plain= false }} → 4

Template data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:In string in articles based on its TemplateData.

TemplateData for In string

Expand Template data

No description. Template parameters Parameter Description Type Status 1 1 no description Unknown optional 2 2 no description Unknown optional 3 3 no description Unknown optional 4 4 no description Unknown optional source source no description Unknown optional target target no description Unknown optional start start no description Unknown optional plain plain no description Unknown optional nomatch nomatch no description Unknown optional