GravityView_Widget_Calendar
Widget to display calendar view
Since: 1.1.0
Source: includes/class-gravityview-widget-calendar.php:31
Details
- Kind:
class - Namespace:
(global) - Extends:
Widget
Methods
| Method | Description |
|---|---|
admin_enqueue_ui_assets() | Enqueues UI assets. |
register_no_conflicts() | Adds GravityView scripts and styles to Gravity Forms and GravityView No-Conflict modes. |
get_feed_select_options() | Gets a list of calendar feeds formatted for use as select element options. |
modify_datatables_output() | Modifies output returned from the DataTables Ajax request. |
render_frontend() | Renders the widget. |
get_entries() | Gets entries (events) based on View configuration. |
Method Reference
admin_enqueue_ui_assets()
function admin_enqueue_ui_assets()
Enqueues UI assets.
Returns
void
Since: 1.1.0
Source: includes/class-gravityview-widget-calendar.php:93
register_no_conflicts()
function register_no_conflicts( $registered )
Adds GravityView scripts and styles to Gravity Forms and GravityView No-Conflict modes.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$registered | array | Existing scripts or styles that have been registered (array of the handles). |
Returns
array— $registered
Since: 1.1.0
Source: includes/class-gravityview-widget-calendar.php:126
get_feed_select_options()
function get_feed_select_options()
Gets a list of calendar feeds formatted for use as select element options.
Returns
array— $feeds_data
Since: 1.1.0
Source: includes/class-gravityview-widget-calendar.php:139
modify_datatables_output()
function modify_datatables_output( $output, $view, $view_entries=null )
Modifies output returned from the DataTables Ajax request.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$output | array | Ajax output. | |
$view | View | GravityView View. | |
$view_entries | Entry_Collection | null | null | View entries. |
Returns
array— Modified output
Since: 1.4
Source: includes/class-gravityview-widget-calendar.php:174
render_frontend()
function render_frontend( $widget_args, $content='', $context='' )
Renders the widget.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$widget_args | array | The Widget shortcode args. | |
$content | string | '' | The content. |
$context | Template_Context | '' | The context. |
Returns
string|void— Rendered calendar widget or return nothing if feed is not defined
Since: 1.1.0
Source: includes/class-gravityview-widget-calendar.php:251
get_entries()
function get_entries( $widget_args, $view, $context='' )
Gets entries (events) based on View configuration.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$widget_args | array | ||
$view | GV\View | ||
$context | string | GV\Template_Context | '' |
Returns
array[GV\GF_Entry]
Deprecated: 2.4
Source: includes/class-gravityview-widget-calendar.php:345