Function __global->generate_svg_sprite
Definitions
sources/themes3.php
- The actualiser to generate an SVG sprite.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $theme | ID_TEXT | No | No | required parameter | N/A | N/A | Theme |
| $monochrome | boolean | No | No | required parameter | N/A | N/A | Whether to generate the monochrome sprite |
| $userland | boolean | No | No | required parameter | N/A | N/A | Whether to include icons from the custom directory, and save the sprite in the custom directory |
Returns
- A pair: Sprite path, list of icons added to sprite
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* The actualiser to generate an SVG sprite.
*
* @param ID_TEXT $theme Theme
* @param boolean $monochrome Whether to generate the monochrome sprite
* @param boolean $userland Whether to include icons from the custom directory, and save the sprite in the custom directory
* @return array A pair: Sprite path, list of icons added to sprite
*/
function generate_svg_sprite(string $theme, bool $monochrome, bool $userland) : array
* The actualiser to generate an SVG sprite.
*
* @param ID_TEXT $theme Theme
* @param boolean $monochrome Whether to generate the monochrome sprite
* @param boolean $userland Whether to include icons from the custom directory, and save the sprite in the custom directory
* @return array A pair: Sprite path, list of icons added to sprite
*/
function generate_svg_sprite(string $theme, bool $monochrome, bool $userland) : array
