Template:Str find

From Wikimedia Commons, the free media repository
Jump to: navigation, search

1

Documentation icon Documentation[view] [edit] [history] [purge]

This documentation is transcluded from Template:Str find/doc.


Usage
Returns the position (1 for the first character) of first appearance of substring in a text, -1 if not found.
Note: if you want to edit this template, first try your modifications on {{Str find/sandbox}}.You can then test your edits in {{Str find/testcases}}.
When the new version is ready, you can move it to the main template.
Examples
  • {{Str find|Panthera (genus)|P}} → 1 (first character)
  • {{Str find|Panthera (genus)|a}} → 2 (second character)
  • {{Str find|Panthera (genus)|(}} → 10
  • {{Str find|Panthera (genus)|/}} → -1 (means not found)
  • {{Str find|Panthera (genus)|}} → 1 (Warning: empty substring returns 1)
Syntax
{{Str find | <text> | <substring> }}
Parameters
  • <text>
the tested string
  • <substring>
the substring to be searched in the <text>
Nuvola apps important.svg if <substring> is empty, this template returns 1
Nuvola apps important.svg you cannot search for = as it is interpreted as a parameter separator
See also

Trimming templates:

  • {{Trunc}} – To trim down to a specified number of characters.
  • {{Trim}} — To trim any leading or trailing whitespace.
  • {{Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.

Analyzing templates:

  • {{Str endswith}} – To check if a string ends with a given string.
  • {{Str find}} – Returns the numerical location of a given string in a string, up to 50 characters.
  • {{Str len}} – Returns a string's length. Can count up to 500 characters.

String length comparison templates:

  • {{Str ≤ len}} – To check if a string is "shorter or equally long" or "longer" than a given length.

Sandboxes and test cases:

Technical stuff:

Feature requests:

  • bugzilla:6455 - Set $wgPFEnableStringFunctions = true on WMF wikis
  • bugzilla:26092 - Enable or install string parsing wikimarkup functionality on WMF wikis