Function __global->actual_edit_catalogue_field
Definitions
sources/catalogues2.php
- Edit a catalogue field.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the field |
| $c_name | ID_TEXT | No | No | required parameter | N/A | N/A | The name of the catalogue |
| $name | ?SHORT_TEXT | No | No | required parameter | N/A | N/A | The name of the field (null: do not change) |
| $description | ?LONG_TEXT | No | No | required parameter | N/A | N/A | Description for the field (null: do not change) |
| $order | integer | No | No | required parameter | N/A | N/A | The field order (the field order determines what order the fields are displayed within an entry) |
| $defines_order | BINARY | No | No | required parameter | N/A | N/A | Whether the field defines entry ordering |
| $visible | BINARY | No | No | required parameter | N/A | N/A | Whether the field is visible when an entry is viewed |
| $sensitive | BINARY | No | No | required parameter | N/A | N/A | Whether this field contains sensitive or personal data |
| $default | LONG_TEXT | No | No | required parameter | N/A | N/A | The default value for the field |
| $required | BINARY | No | No | required parameter | N/A | N/A | Whether the field is required |
| $is_sortable | BINARY | No | No | required parameter | N/A | N/A | Whether the field is sortable |
| $include_in_main_search | BINARY | No | No | required parameter | N/A | N/A | Whether the field is included in main search |
| $allow_template_search | BINARY | No | No | required parameter | N/A | N/A | Whether to allow template search |
| $put_in_category | BINARY | No | No | 1 | N/A | N/A | Whether the field is to be shown in category views (not applicable for the list display type) |
| $put_in_search | BINARY | No | No | 1 | N/A | N/A | Whether the field is to be shown in search views (not applicable for the list display type) |
| $options | SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | Field options |
| $type | ?ID_TEXT | No | No | Null | N/A | N/A | The field type (null: do not change) |
Preview
Code (PHP)
/**
* Edit a catalogue field.
*
* @param AUTO_LINK $id The ID of the field
* @param ID_TEXT $c_name The name of the catalogue
* @param ?SHORT_TEXT $name The name of the field (null: do not change)
* @param ?LONG_TEXT $description Description for the field (null: do not change)
* @param integer $order The field order (the field order determines what order the fields are displayed within an entry)
* @param BINARY $defines_order Whether the field defines entry ordering
* @param BINARY $visible Whether the field is visible when an entry is viewed
* @param BINARY $sensitive Whether this field contains sensitive or personal data
* @param LONG_TEXT $default The default value for the field
* @param BINARY $required Whether the field is required
* @param BINARY $is_sortable Whether the field is sortable
* @param BINARY $include_in_main_search Whether the field is included in main search
* @param BINARY $allow_template_search Whether to allow template search
* @param BINARY $put_in_category Whether the field is to be shown in category views (not applicable for the list display type)
* @param BINARY $put_in_search Whether the field is to be shown in search views (not applicable for the list display type)
* @param SHORT_TEXT $options Field options
* @param ?ID_TEXT $type The field type (null: do not change)
*/
function actual_edit_catalogue_field(int $id, string $c_name, ?string $name, ?string $description, int $order, int $defines_order, int $visible, int $sensitive, string $default, int $required, int $is_sortable, int $include_in_main_search, int $allow_template_search, int $put_in_category = 1, int $put_in_search = 1, string $options = '', ?string $type = null)
* Edit a catalogue field.
*
* @param AUTO_LINK $id The ID of the field
* @param ID_TEXT $c_name The name of the catalogue
* @param ?SHORT_TEXT $name The name of the field (null: do not change)
* @param ?LONG_TEXT $description Description for the field (null: do not change)
* @param integer $order The field order (the field order determines what order the fields are displayed within an entry)
* @param BINARY $defines_order Whether the field defines entry ordering
* @param BINARY $visible Whether the field is visible when an entry is viewed
* @param BINARY $sensitive Whether this field contains sensitive or personal data
* @param LONG_TEXT $default The default value for the field
* @param BINARY $required Whether the field is required
* @param BINARY $is_sortable Whether the field is sortable
* @param BINARY $include_in_main_search Whether the field is included in main search
* @param BINARY $allow_template_search Whether to allow template search
* @param BINARY $put_in_category Whether the field is to be shown in category views (not applicable for the list display type)
* @param BINARY $put_in_search Whether the field is to be shown in search views (not applicable for the list display type)
* @param SHORT_TEXT $options Field options
* @param ?ID_TEXT $type The field type (null: do not change)
*/
function actual_edit_catalogue_field(int $id, string $c_name, ?string $name, ?string $description, int $order, int $defines_order, int $visible, int $sensitive, string $default, int $required, int $is_sortable, int $include_in_main_search, int $allow_template_search, int $put_in_category = 1, int $put_in_search = 1, string $options = '', ?string $type = null)