SproutCMS

This is the code documentation for the SproutCMS project

function widgetTile()

Register a widget "tile", which is shown when adding widgets (content blocks) to a page

If a tile already exists with that name, the widgets will be added to that tile

A list of available icons can be found in the file sprout/media/fonts/iconfont/demo.html

Usage

void Register::widgetTile ( string $area_name , string $name , string $icon , string $text , array $widgets );

Arguments

  1. string $area_name
    The area to register the tile (e.g. 'embedded')
  2. string $name
    The name (title) of the tile
  3. string $icon
    The icon class, sans the 'icon-' part. Examples: 'list', 'grid', 'home', etc.
  4. string $text
    Explanation text. Plaintext.
  5. array $widgets
    Widgets to show as links, in format 'name' => 'label'

Return value

  • void