Function Forum_driver_cns->get_matching_members
Definitions
sources/forum/cns.php
- Find all members with a name matching the given SQL LIKE string.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $pattern | string | No | No | required parameter | N/A | N/A | The pattern |
| $limit | ?integer | No | No | Null | N/A | N/A | Maximum number to return (limits to the most recent active) (null: no limit) |
| $friends | boolean | No | No | False | N/A | N/A | Whether to limit to friends of the current member, if possible |
Returns
- The array of matched members (null: none found)
- Type: ?array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find all members with a name matching the given SQL LIKE string.
*
* @param string $pattern The pattern
* @param ?integer $limit Maximum number to return (limits to the most recent active) (null: no limit)
* @param boolean $friends Whether to limit to friends of the current member, if possible
* @return ?array The array of matched members (null: none found)
*/
public function get_matching_members(string $pattern, ?int $limit = null, bool $friends = false) : ?array
* Find all members with a name matching the given SQL LIKE string.
*
* @param string $pattern The pattern
* @param ?integer $limit Maximum number to return (limits to the most recent active) (null: no limit)
* @param boolean $friends Whether to limit to friends of the current member, if possible
* @return ?array The array of matched members (null: none found)
*/
public function get_matching_members(string $pattern, ?int $limit = null, bool $friends = false) : ?array