SproutCMS

class HelloWorldWidget

Basically just a test widget

• File: /sprout/Widgets/HelloWorldWidget.php
• Namespace: Sprout\Widgets
• Extends: Widget

Variables

Array of default settings for new widgets

Optional HTML H2 heading that's rendered on front-end view

Settings - These get automatically set in the admin and loaded on the front-end

Functions

public cleanupSettings (from Widget)

Run after import of settings, allows extending widgets to clean up settings which may
have bad values for some reason

public getDefaultSettings (from Widget)

Returns the default settings for the widget

public getEditUrl (from Widget)

This function should return a URL which can be used to edit the *content* which is
displayed by this widget.

Most widgets show content using a category selection box; the URL should in that
case direct the user to the contents list for that category.

Return NULL if there isn't an appropriate URL to use.

public getFriendlyDesc (from Widget)

Gets the english name of this widget

public getFriendlyName (from Widget)

Gets the english name of this widget

public getInfoLabels (from Widget)

This function should return a summary of what this widget's *content* is.
Don't specify the widget name; we already know that!

Most widgets show content using a category selection box; in that case
the most useful thing is probably the category name, perhaps also the
order and limit.

Return NULL if there isn't an appropriate label to use.

public getNotAvailableReason (from Widget)

Is there sufficent content to add this addon at the moment?
If this widget is not available, a string message should be returned
If this widget *is* available, NULL should be returned.

public getSettings (from Widget)

Return the currently loaded settings for the widget

public getSettingsForm

Return the settings form for this widget

public getTitle (from Widget)

Returns the title to use for the widget - should not contain HTML

public importSettings (from Widget)

Imports the settings

public render

Return the front-end view of this widget

public setTitle (from Widget)

Set widget title