Class Widget

WP_Widget

Extended by

hji\common\interfaces\Widget

Direct known subclasses

hji\construction\core\Widget, REL\widgets\PocketListingsSearchWidget, REL\widgets\PocketListingsWidget

Indirect known subclasses

hji\construction\models\NCSearchWidget

Abstract
Namespace: hji\common\interfaces
Located at common/interfaces/Widget.php

Methods summary

`public`	# `widget( array $args, array $instance )` Renders widget content on the page Implementation of WP_Widget::widget(); Renders widget content on the page Implementation of WP_Widget::widget(); Parameters `$args` `$instance`
`public string\|`	# `form( array $instance )` Renders form content on the page Implementation of WP_Widget::form(); Renders form content on the page Implementation of WP_Widget::form(); Parameters `$instance` Returns string\|
`public boolean\|string`	# `getWidgetContent( $args, $instance )` Returns widget content Returns widget content Parameters `$args` `$instance` Returns boolean\|string
`public boolean\|string`	# `getFormContent( $instance )` Returns form content Returns form content Parameters `$instance` Returns boolean\|string
`public`	# `get_field_name( $field_name )`
`public`	# `get_field_id( $field_id )`
`public hji\common\utils\Views`	# `getFormView( )` IMPORTANT: Assign .shortcode-value class to form input fields markup which values should be part of the shortcode IMPORTANT: Assign .shortcode-value class to form input fields markup which values should be part of the shortcode Returns `hji\common\utils\Views`
`public`	# `getWidgetView( )`
`public`	# `getView( $filePath )`
`abstract public`	# `prepareWidget( $instance, $args )`
`abstract public`	# `prepareForm( $instance )`
`abstract public`	# `getWidgetTemplateFile( )`
`abstract public`	# `getFormTemplateFile( )`

Properties summary

`public static`	`$supportedFields` Supported fields are currently not used within the Widget object, but they are supported by Shortcodes class, which will validate shortcode attributes against widget's supported fields, if they are defined. [\hji\common\interfaces\Shortcode::validateParameters()] Supported fields are currently not used within the Widget object, but they are supported by Shortcodes class, which will validate shortcode attributes against widget's supported fields, if they are defined. [\hji\common\interfaces\Shortcode::validateParameters()]	#
`public boolean`	`$isTinyMcePlugin` TinyMCE flag that is being set when Widget object is created within the tinyMCE Plugin's PopUp window. TinyMCE flag that is being set when Widget object is created within the tinyMCE Plugin's PopUp window.	# `false`