Function Hook_fields_short_trans_multi->render_field_value
Definitions
sources/hooks/systems/fields/short_trans_multi.php
- Convert a field value to something renderable.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| &$field | array | Yes | No | required parameter | N/A | N/A | The field details |
| $ev | mixed | No | No | required parameter | N/A | N/A | The raw value |
| $i | integer | No | No | required parameter | N/A | N/A | Position in fieldset |
| $only_fields | ?array | No | No | required parameter | N/A | N/A | List of fields the output is being limited to (null: N/A) |
| $table | ?ID_TEXT | No | No | Null | N/A | N/A | The table we store in (null: N/A) |
| $id | ?AUTO_LINK | No | No | Null | N/A | N/A | The ID of the row in the table (null: N/A) |
| $id_field | ?ID_TEXT | No | No | Null | N/A | N/A | Name of the ID field in the table (null: N/A) |
| $field_id_field | ?ID_TEXT | No | No | Null | N/A | N/A | Name of the field ID field in the table (null: N/A) |
| $url_field | ?ID_TEXT | No | No | Null | N/A | N/A | Name of the URL field in the table (null: N/A) |
| $submitter | ?MEMBER | No | No | Null | N/A | N/A | Submitter (null: current member) |
| $ev_pure | ?mixed | No | No | Null | N/A | N/A | The 'pure' form of the raw value, meaning Comcode is not pre-parsed and string conversion has not been performed (null: unknown) |
Returns
- Rendered field (string or Tempcode)
- Type: mixed
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Convert a field value to something renderable.
*
* @param array $field The field details
* @param mixed $ev The raw value
* @param integer $i Position in fieldset
* @param ?array $only_fields List of fields the output is being limited to (null: N/A)
* @param ?ID_TEXT $table The table we store in (null: N/A)
* @param ?AUTO_LINK $id The ID of the row in the table (null: N/A)
* @param ?ID_TEXT $id_field Name of the ID field in the table (null: N/A)
* @param ?ID_TEXT $field_id_field Name of the field ID field in the table (null: N/A)
* @param ?ID_TEXT $url_field Name of the URL field in the table (null: N/A)
* @param ?MEMBER $submitter Submitter (null: current member)
* @param ?mixed $ev_pure The 'pure' form of the raw value, meaning Comcode is not pre-parsed and string conversion has not been performed (null: unknown)
* @return mixed Rendered field (string or Tempcode)
*/
public function render_field_value(array &$field, $ev, int $i, ?array $only_fields, ?string $table = null, ?int $id = null, ?string $id_field = null, ?string $field_id_field = null, ?string $url_field = null, ?int $submitter = null, $ev_pure = null)
* Convert a field value to something renderable.
*
* @param array $field The field details
* @param mixed $ev The raw value
* @param integer $i Position in fieldset
* @param ?array $only_fields List of fields the output is being limited to (null: N/A)
* @param ?ID_TEXT $table The table we store in (null: N/A)
* @param ?AUTO_LINK $id The ID of the row in the table (null: N/A)
* @param ?ID_TEXT $id_field Name of the ID field in the table (null: N/A)
* @param ?ID_TEXT $field_id_field Name of the field ID field in the table (null: N/A)
* @param ?ID_TEXT $url_field Name of the URL field in the table (null: N/A)
* @param ?MEMBER $submitter Submitter (null: current member)
* @param ?mixed $ev_pure The 'pure' form of the raw value, meaning Comcode is not pre-parsed and string conversion has not been performed (null: unknown)
* @return mixed Rendered field (string or Tempcode)
*/
public function render_field_value(array &$field, $ev, int $i, ?array $only_fields, ?string $table = null, ?int $id = null, ?string $id_field = null, ?string $field_id_field = null, ?string $url_field = null, ?int $submitter = null, $ev_pure = null)
