A simple module type that provides formatting of text fields.
Please see the base Module interface for all potential methods that a Textformatter module can have.
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Textformatter class also inherits all the methods and properties of: WireData and Wire.
Common
| Name | Return | Summary | |
|---|---|---|---|
Textformatter::format() Textformatter::format(string $str) Textformatter::format(string $str) | (nothing) | Format the given text string, outside of specific Page or Field context. | |
Textformatter::formatValue() Textformatter::formatValue(Page $page, Field $field, $value) Textformatter::formatValue(Page $page, Field $field, $value) | (nothing) | Format the given text string with Page and Field provided. |
Additional methods and properties
In addition to the methods and properties above, Textformatter also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.248