Reference_Container
extends Base
in package
Registers a Widget to put the Reference Container to the widget area.
Tags
Table of Contents
- $plugin_name : string
- The ID of this plugin.
- __construct() : mixed
- Initialize the class and set its properties.
- form() : mixed
- Outputs the Settings of the Widget.
- widget() : mixed
- Outputs the Content of the Widget.
- get_description() : string
- Returns the Description of the child widget.
- get_id() : string
- Returns an unique ID as string used for the Widget Base ID.
- get_name() : string
- Returns the Public name of the Widget to be displayed in the Configuration page.
- get_widget_width() : int
- Returns the width of the Widget. Default width is 250 pixel.
Properties
$plugin_name
The ID of this plugin.
private
string
$plugin_name
Tags
Methods
__construct()
Initialize the class and set its properties.
public
__construct(string $plugin_name) : mixed
Parameters
- $plugin_name : string
-
The name of this plugin.
Tags
Return values
mixed —form()
Outputs the Settings of the Widget.
public
form(mixed $instance) : mixed
Parameters
- $instance : mixed
-
The instance of the widget.
Tags
Return values
mixed —widget()
Outputs the Content of the Widget.
public
widget(mixed $args, mixed $instance) : mixed
Parameters
- $args : mixed
-
The widget's arguments.
- $instance : mixed
-
The instance of the widget.
Tags
Return values
mixed —get_description()
Returns the Description of the child widget.
protected
get_description() : string
Tags
Return values
string —get_id()
Returns an unique ID as string used for the Widget Base ID.
protected
get_id() : string
Tags
Return values
string —get_name()
Returns the Public name of the Widget to be displayed in the Configuration page.
protected
get_name() : string
Tags
Return values
string —get_widget_width()
Returns the width of the Widget. Default width is 250 pixel.
protected
get_widget_width() : int