Developer's Manual  Blocks  Property types  text

text

Allows to enter text.

The text type has two additional optional parameters search and nl2br.

search

Optional. Specifies whether to include property value into the search index or not. Possible values for search are:

Value Description
0 Do not include property value into search index.
1 Include property value into search index.

If search is omitted 0 is assumed.

nl2br

Optional. Specifies how to show the property value in block properties mode.

Value Description
0 Do not convert \n to <br>
1 Convert \n to <br>

If nl2br is omitted 0 is assumed.

Example

<?
$properties
= Array(
  
'text' => Array(
    
'type'     => 'text',
    
'value'    => 'Hello world',
    
'label'    => 'Text',
    
'search'   => 1      // include into search index
  
)
);
?>

The text type has Text Editor assigned to it.

Please login to add comments.