Documentation

Base extends WP_Widget

Base class to be extended by all widget sub-classes.

Any sub-class must override the appropriate method(s) provided by WP_Widget.

Tags
abstract
since
1.5.0
todo

Review implemenation of Widgets API.

Table of Contents

__construct()  : mixed
Registers the child Widget to WordPress.
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 child Widget to be displayed in the Configuration page.
get_widget_width()  : int
Returns the width of the Widget. Default width is 250 pixel.

Methods

__construct()

Registers the child Widget to WordPress.

public __construct() : mixed
Tags
since
1.5.0
Return values
mixed

get_description()

Returns the Description of the child widget.

protected abstract get_description() : string
Tags
abstract
since
1.5.0
Return values
string

get_id()

Returns an unique ID as string used for the Widget Base ID.

protected abstract get_id() : string
Tags
abstract
since
1.5.0
Return values
string

get_name()

Returns the Public name of child Widget to be displayed in the Configuration page.

protected abstract get_name() : string
Tags
abstract
since
1.5.0
Return values
string

get_widget_width()

Returns the width of the Widget. Default width is 250 pixel.

protected get_widget_width() : int
Tags
since
1.5.0
Return values
int

Search results