Function __global->insert_lang_comcode
Definitions
sources/lang.php
- Insert a Comcode content language string into the translation table, and return details of the content language string.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $field_name | ID_TEXT | required parameter | N/A | N/A | The field name |
| $text | string | required parameter | N/A | N/A | The text |
| $level | integer | required parameter | N/A | N/A | The level of importance this content language string holds |
| $db | ?object | Null | N/A | N/A | The database connector to use (null: standard site connector) |
| $insert_as_admin | boolean | False | N/A | N/A | Whether to insert it as an admin (any Comcode parsing will be carried out with admin privileges) |
| $pass_id | ?string | Null | N/A | N/A | The special identifier for this content language string on the page it will be displayed on; this is used to provide an explicit binding between languaged elements and greater templated areas (null: none) |
| $preparse_mode | boolean | True | N/A | N/A | Whether to generate a fatal error if there is invalid Comcode |
| $save_as_volatile | boolean | False | N/A | N/A | Whether we are saving as a 'volatile' file extension (used in the XML DB driver, to mark things as being non-syndicated to Git) |
Return
- The content language string save fields
- Type: array
- Set: N/A
- Range: N/A