Function Hook_task_import_newsletter_subscribers->run
Definitions
sources/hooks/systems/tasks/import_newsletter_subscribers.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 |
|---|---|---|---|---|---|
| $_language | LANGUAGE_NAME | required parameter | N/A | N/A | The language for subscribers |
| $newsletter_id | AUTO_LINK | required parameter | N/A | N/A | The newsletter being imported into |
| $subscribe | boolean | required parameter | N/A | N/A | Whether we are subscribing the member (true=adding, false=removing) |
| $path | PATH | required parameter | N/A | N/A | The path of the file to import |
| $filename | ?string | Null | N/A | N/A | The filename of the file to import (null: detect from $path) |
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