Function Hook_task_export_members->run
Definitions
sources/hooks/systems/tasks/export_members.php
- Run the task hook.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $filter_by_allow | boolean | required parameter | N/A | N/A | Only provide members that have "Receive newsletters and other site updates" set |
| $fields_to_use | array | required parameter | N/A | N/A | List of fields to use (empty: none) |
| $usergroups | array | required parameter | N/A | N/A | List of usergroups to use (empty: all) |
| $order_by | string | required parameter | N/A | N/A | Field to order by |
| $file_type | ?string | Null | N/A | N/A | The file type to export with (null: default) |
Return
- A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
- Type: ?array
- Set: N/A
- Range: N/A