Skip to content
For AI agents: the complete documentation index is available at llms.txt; this page is also available as Markdown at index.md.
  • Documentation >
  • Content management >
  • Field types >
  • Field type reference >
  • Keyword field type

Keyword field type

This field type stores one or several comma-separated keywords as a string or array of strings.

Name Internal name Expected input
Keyword ibexa_keyword string[] or string

PHP API field type

Input expectations

Type Example
string "documentation"
string "php, Ibexa Platform, html5"
string[] [ "Ibexa", "Enterprise", "User Experience Management" ]

Value object

Properties

The Value class of this field type contains the following properties:

Property Type Description
$values string[] Holds an array of keywords as strings. 
1
2
3
4
5
6
7
8
// Value object content example
use Ibexa\Core\FieldType\Keyword\Value;

// Instantiates a Value object
$keywordValue = new Value();

// Sets an array of keywords as a value
$keywordValue->values = ['php', 'css3', 'html5', 'Ibexa Platform'];

Constructor

The Keyword\Value constructor initializes a new value object with the value provided.

It expects a list of keywords, either comma-separated in a string or as an array of strings.

1
2
3
4
5
6
7
8
9
// Constructor example
use Ibexa\Core\FieldType\Keyword\Value;

// Instantiates a Value object with an array of keywords
$keywordValue = new Value(['php5', 'css3', 'html5']);

// Instantiates a Value object with a list of keywords in a string
// This is equivalent to the example above
$keywordValue = new Value('php5,css3,html5');
View as Markdown View on GitHub