Template:Str len/doc

__NOWYSIWYG__

Description
This is the meta-template.

It takes a string as parameter and returns its length (excluding spaces at the start and end). It can count up to 500 in length, and returns 500 for strings that are too long.

Note! For most usage cases it is much easier and costs much less server resources to use str ≥ len or one of its sister templates. See the see also section below.

Examples
If the parameter is empty or undefined it is considered to be of zero length:


 * returns 0
 * returns 0
 * returns 0

It counts the length correctly, even if the string contains spaces, looks like a number, or contains special characters:


 * returns 6


 * returns 7


 * returns 8

It can measure strings up to 500 in length, and returns 500 for strings that are too long:


 * returns 499
 * returns 1000

Technical details
MediaWiki has no parser function or magic word to measure string lengths. And measuring string length using template code is very heavy on the servers. Thus this template is as optimised as possible. But you should consider using str ≥ len instead, since for most usage cases it is much easier to use and it costs much less server resources.

This template calls str len/core which does most of the work. For documentation on the internal workings of these two templates see /core. The original talk page at Wikipedia might also have more details.