Module:String/doc

From MiiWiki
Jump to navigationJump to search

This is the documentation page for Module: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

  • ignore_errors: 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 [Category:Errors reported by Module String].
  • no_category: If set to 'true' or 1, no category will be added if an error is generated.