FieldtypeText class

Field that stores a single line of text

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the FieldtypeText class also inherits all the methods and properties of: Fieldtype, WireData and Wire.

Common

Name	Return	Summary
FieldtypeText::formatValue() FieldtypeText::formatValue(Page $page, Field $field, string $value) FieldtypeText::formatValue(Page $page, Field $field, string $value)	`string`	Format value for output
FieldtypeText::getCompatibleFieldtypes() FieldtypeText::getCompatibleFieldtypes(Field $field) FieldtypeText::getCompatibleFieldtypes(Field $field)	`Fieldtypes`	Return all Fieldtypes derived from FieldtypeText, which we will consider compatible
FieldtypeText::getConfigInputfields() FieldtypeText::getConfigInputfields(Field $field) FieldtypeText::getConfigInputfields(Field $field)	`InputfieldWrapper`	Return the fields required to configure an instance of FieldtypeText
FieldtypeText::getDatabaseSchema() FieldtypeText::getDatabaseSchema(Field $field) FieldtypeText::getDatabaseSchema(Field $field)	`array`	Return the database schema in specified format
FieldtypeText::getInputfield() FieldtypeText::getInputfield(Page $page, Field $field) FieldtypeText::getInputfield(Page $page, Field $field)	`Inputfield`	Return the associated Inputfield
FieldtypeText::getMatchQuery() FieldtypeText::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, $value) FieldtypeText::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, $value)	`DatabaseQuerySelect`	Update a query to match the text with a fulltext index
FieldtypeText::importConfigData() FieldtypeText::importConfigData(Field $field, array $data) FieldtypeText::importConfigData(Field $field, array $data)	`array`	Convert an array of exported data to a format that will be understood internally
FieldtypeText::importValue() FieldtypeText::importValue(Page $page, Field $field, $value) FieldtypeText::importValue(Page $page, Field $field, $value, array $options = [])	`array` `string`	Import value
FieldtypeText::isEmptyValue() FieldtypeText::isEmptyValue(Field $field, mixed $value) FieldtypeText::isEmptyValue(Field $field, mixed $value)	`bool`	Return whether the given value is considered empty or not
FieldtypeText::sanitizeValue() FieldtypeText::sanitizeValue(Page $page, Field $field, string $value) FieldtypeText::sanitizeValue(Page $page, Field $field, string $value)	`string`	Sanitize value for storage
FieldtypeText::saveFieldReady() FieldtypeText::saveFieldReady(Field $field) FieldtypeText::saveFieldReady(Field $field)	(nothing)	Hook called when field is about to be saved

Additional methods and properties

In addition to the methods and properties above, FieldtypeText also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Field that stores a single line of text

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news