Kocuj Sitemap - WordPress plugin
Back to top  

Widget class

access public
package kocuj_internal_lib

 Methods

Constructor

__construct(string $widgetId, string $title, array $settings) : void
access public

Parameters

$widgetId

string

Widget identifier

$title

string

Widget title

$settings

array

Settings; there are the following settings which must be used: "global_additional" (array type; additional settings; there are the following additional settings which can be used: "defaultitle" (string type; default title which will be used if title is empty), "optiondisplaytitle" (string type; option name for displaying or not displaying the title), "optiondisplaytitlelabel" (string type; label for option for displaying or not displaying the title), "optiondisplaytitletooltip" (string type; tooltip for option for displaying or not displaying the title), "optiontitle" (string type; option name for title), "optiontitlelabel" (string type; label for option for title), "optiontitletooltip" (string type; tooltip for option for title)), "global_containerid" (string type; container identifier), "global_description" (string type; widget description), "global_projectobj" (object type; project object)

Display widget form

form(array $options) : void
access public

Parameters

$options

array

Widget options

Update widget options

update(array $newOptions, array $oldOptions) : array
access public

Parameters

$newOptions

array

New options

$oldOptions

array

Old options

Returns

arrayParsed values

Display widget

widget(array $args, array $options) : void
access public

Parameters

$args

array

Widget arguments

$options

array

Widget options

Display form; should be used inside "form" method to display form

displayForm() : void
access protected

Display widget content; should be used inside "widget" method to display widget content

displayWidgetContent(array $args, string $widgetOutput) : void
access protected

Parameters

$args

array

Widget arguments

$widgetOutput

string

Widget output to display

Get additional settings

getAdditional() : array
access protected

Returns

arrayAdditional settings

Get container identifier

getContainerId() : string
access protected

Returns

stringContainer identifier

Get project object

getProjectObj() : object
access protected

Returns

objectProject object

 Properties

 

Additional settings

$additional : array

Default

array()
access private
 

Container identifier

$containerId : string

Default

''
access private
 

Project object

$projectObj : object

Default

NULL
access private