Function Hook_CMA->get_textual_field
Definitions
sources/content.php
- Get particular textual information from a content row.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $row | array | No | No | required parameter | N/A | N/A | The database row for the content |
| $render_type | integer | No | No | required parameter | N/A | N/A | A FIELD_RENDER_* constant |
| $info | array | No | No | required parameter | N/A | N/A | The info map for the content type |
| $field | string | No | No | required parameter | N/A | N/A | The field name for what we are looking up |
| $dereference | boolean | No | No | required parameter | N/A | N/A | Whether we need to dereference the field as a language string |
| $supports_comcode | boolean | No | No | required parameter | N/A | N/A | Whether the field supports Comcode |
| $resource_fs_style | boolean | No | No | False | N/A | N/A | Whether to use the content API as resource-fs requires (may be slightly different) |
Returns
- Content title (string or Tempcode, depending on $render_type) (null: could not generate)
- Type: ?mixed
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get particular textual information from a content row.
*
* @param array $row The database row for the content
* @param integer $render_type A FIELD_RENDER_* constant
* @param array $info The info map for the content type
* @param string $field The field name for what we are looking up
* @param boolean $dereference Whether we need to dereference the field as a language string
* @param boolean $supports_comcode Whether the field supports Comcode
* @param boolean $resource_fs_style Whether to use the content API as resource-fs requires (may be slightly different)
* @return ?mixed Content title (string or Tempcode, depending on $render_type) (null: could not generate)
*/
protected function get_textual_field(array $row, int $render_type, array $info, string $field, bool $dereference, bool $supports_comcode, bool $resource_fs_style = false)
* Get particular textual information from a content row.
*
* @param array $row The database row for the content
* @param integer $render_type A FIELD_RENDER_* constant
* @param array $info The info map for the content type
* @param string $field The field name for what we are looking up
* @param boolean $dereference Whether we need to dereference the field as a language string
* @param boolean $supports_comcode Whether the field supports Comcode
* @param boolean $resource_fs_style Whether to use the content API as resource-fs requires (may be slightly different)
* @return ?mixed Content title (string or Tempcode, depending on $render_type) (null: could not generate)
*/
protected function get_textual_field(array $row, int $render_type, array $info, string $field, bool $dereference, bool $supports_comcode, bool $resource_fs_style = false)
