SproutCMS

This is the code documentation for the SproutCMS project

function render()

Instantiate, import settings, and render

Usage

string Widgets::render ( int $orientation , string $name , array $settings [, string $pre_html [, string $post_html [, string $heading [, string $template ]]]] );

Arguments

  1. int $orientation
    See ORIENTATION_* constants in WidgetArea
  2. string $name
    Class name of the widget
  3. array $settings
    Widget settings (keys and values vary with widget subclass)
  4. string $pre_html = NULL
    HTML to go before the rendered widget
  5. string $post_html = NULL
    HTML to go after the rendered widget
  6. string $heading = NULL
    String Optional HTML H2 rendered on front-end of given widget
  7. string $template = NULL
    String Optional wrapping template name

Return value

  • string
    Front-end HTML of widget