Function __global->perform_keyword_search
Definitions
sources/search.php
- Find data about most popular keyword usage, with optional constraints.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $limit_to | ?array | No | No | Null | N/A | N/A | List of SEO type codes to limit to (null: no limit) |
| $keyword_prefix | ?string | No | No | Null | N/A | N/A | Keyword prefix to limit to (null: no limit) |
| $max | integer | No | No | 300 | N/A | N/A | Maximum number of results to return |
| $apply_permissions | boolean | No | No | True | N/A | N/A | Whether to apply permissions |
Returns
- Map between keyword and count, in commonality order
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find data about most popular keyword usage, with optional constraints.
*
* @param ?array $limit_to List of SEO type codes to limit to (null: no limit)
* @param ?string $keyword_prefix Keyword prefix to limit to (null: no limit)
* @param integer $max Maximum number of results to return
* @param boolean $apply_permissions Whether to apply permissions
* @return array Map between keyword and count, in commonality order
*/
function perform_keyword_search(?array $limit_to = null, ?string $keyword_prefix = null, int $max = 300, bool $apply_permissions = true) : array
* Find data about most popular keyword usage, with optional constraints.
*
* @param ?array $limit_to List of SEO type codes to limit to (null: no limit)
* @param ?string $keyword_prefix Keyword prefix to limit to (null: no limit)
* @param integer $max Maximum number of results to return
* @param boolean $apply_permissions Whether to apply permissions
* @return array Map between keyword and count, in commonality order
*/
function perform_keyword_search(?array $limit_to = null, ?string $keyword_prefix = null, int $max = 300, bool $apply_permissions = true) : array
