Function __global->newsletter_who_send_to
Definitions
sources/newsletter.php
- Find a group of people the newsletter will go to.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $send_details | ?array | No | No | Null | N/A | N/A | A map describing what newsletters the newsletter is being sent to (if $spreadsheet_data is not empty we will always process that regardless) (null: no limitation) |
| $lang | ?LANGUAGE_NAME | No | No | Null | N/A | N/A | Language subscribers should be using (if we're running a multi-language site) (null: no filter) |
| $start | integer | No | No | 0 | N/A | N/A | Start position in result set (results are returned in parallel for each category of result) |
| $max | integer | No | No | 0 | N/A | N/A | Maximum records to return from each category |
| $spreadsheet_data | array | No | No | [] | N/A | N/A | Spreadsheet data to also consider |
| $filter_confirms | boolean | No | No | True | N/A | N/A | Filter non-confirmed addresses out |
Returns
- A pair: List of subscriber detail maps, and a map of newsletter identifier to record count (null if $start is not zero, for performance reasons]
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find a group of people the newsletter will go to.
*
* @param ?array $send_details A map describing what newsletters the newsletter is being sent to (if $spreadsheet_data is not empty we will always process that regardless) (null: no limitation)
* @param ?LANGUAGE_NAME $lang Language subscribers should be using (if we're running a multi-language site) (null: no filter)
* @param integer $start Start position in result set (results are returned in parallel for each category of result)
* @param integer $max Maximum records to return from each category
* @param array $spreadsheet_data Spreadsheet data to also consider
* @param boolean $filter_confirms Filter non-confirmed addresses out
* @return array A pair: List of subscriber detail maps, and a map of newsletter identifier to record count (null if $start is not zero, for performance reasons]
*/
function newsletter_who_send_to(?array $send_details = null, ?string $lang = null, int $start = 0, int $max = 0, array $spreadsheet_data = [], bool $filter_confirms = true) : array
* Find a group of people the newsletter will go to.
*
* @param ?array $send_details A map describing what newsletters the newsletter is being sent to (if $spreadsheet_data is not empty we will always process that regardless) (null: no limitation)
* @param ?LANGUAGE_NAME $lang Language subscribers should be using (if we're running a multi-language site) (null: no filter)
* @param integer $start Start position in result set (results are returned in parallel for each category of result)
* @param integer $max Maximum records to return from each category
* @param array $spreadsheet_data Spreadsheet data to also consider
* @param boolean $filter_confirms Filter non-confirmed addresses out
* @return array A pair: List of subscriber detail maps, and a map of newsletter identifier to record count (null if $start is not zero, for performance reasons]
*/
function newsletter_who_send_to(?array $send_details = null, ?string $lang = null, int $start = 0, int $max = 0, array $spreadsheet_data = [], bool $filter_confirms = true) : array
