aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md')
-rw-r--r--vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md50
1 files changed, 27 insertions, 23 deletions
diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md
index 754014e2d..6163a0785 100644
--- a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md
+++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md
@@ -1,39 +1,43 @@
-string\_format {#language.modifier.string.format}
-==============
+# string_format
This is a way to format strings, such as decimal numbers and such. Use
-the syntax for [`sprintf()`](&url.php-manual;sprintf) for the
+the syntax for [`sprintf()`](https://www.php.net/sprintf) for the
formatting.
- Parameter Position Type Required Default Description
- -------------------- -------- ---------- --------- ---------------------------------------
- 1 string Yes *n/a* This is what format to use. (sprintf)
+## Basic usage
+```smarty
+{$myVar|string_format:"%d"}
+```
+## Parameters
- <?php
+| Parameter Position | Type | Required | Description |
+|--------------------|--------|----------|---------------------------------------|
+| 1 | string | Yes | This is what format to use. (sprintf) |
- $smarty->assign('number', 23.5787446);
+## Examples
- ?>
+```php
+<?php
-
-
-Where template is:
+$smarty->assign('number', 23.5787446);
+```
- {$number}
- {$number|string_format:"%.2f"}
- {$number|string_format:"%d"}
+Where template is:
-
+```smarty
+{$number}
+{$number|string_format:"%.2f"}
+{$number|string_format:"%d"}
+```
Will output:
+```
+23.5787446
+23.58
+23
+```
- 23.5787446
- 23.58
- 23
-
-
-
-See also [`date_format`](#language.modifier.date.format).
+See also [`date_format`](language-modifier-date-format.md).