GravityView_Widget_Calendar
Widget to display calendar view
Since: 1.1.0
Source: includes/class-gravityview-widget-calendar.php:32
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. |
add_refresh_events() | Adds the View's calendar events to GravityView's refresh payload. |
get_all_view_entries() | Returns all of a View's entries, or none while the View is hidden until a search. |
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:97
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:130
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:143
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:178
add_refresh_events()
public function add_refresh_events( $parts, $view, $entries=null, $request=null )
Adds the View's calendar events to GravityView's refresh payload.
A refresh replaces the View's widgets, except the calendar element, which keeps itself and takes its new events from this part.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$parts | array | The payload parts, keyed by part name. | |
$view | View | The View being refreshed. | |
$entries | Entry_Collection | null | null | The entries the payload renders. |
$request | Request | null | null | The request being answered. |
Returns
array— The payload parts.
Since: 2.24.0
Source: includes/class-gravityview-widget-calendar.php:218
get_all_view_entries()
public static function get_all_view_entries( $view, $request=null )
Returns all of a View's entries, or none while the View is hidden until a search.
GravityView returns a hidden View's entries when asked for them; only its templates leave them out.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$view | View | The View. | |
$request | Request | null | null | The request. Default: the current one. |
Returns
array— The View's entries.
Since: 2.24.0
Source: includes/class-gravityview-widget-calendar.php:248
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:346
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:464