{
"generated": "2026-06-10T18:28:04.460Z",
"product": {
"id": "gravityview-datatables",
"label": "DataTables",
"repo": "GravityKit/DataTables",
"version": "3.8.1",
"actions": [
"gk/gravityview/datatables/output/before",
"gravityview_datatables_scripts_styles",
"gravityview_datatables_settings_row"
],
"filters": [
"gravityview/datatables/button",
"gravityview/datatables/button_ . $button",
"gravityview/datatables/config/language",
"gravityview/datatables/config/locale",
"gravityview/datatables/field_filters/atts",
"gravityview/datatables/field_filters/placeholder",
"gravityview/datatables/json/header/content_length",
"gravityview/datatables/output/entry",
"gravityview/datatables/output",
"gravityview/entry/cell/attributes",
"gravityview/entry/row/attributes",
"gravityview/search-all-split-words",
"gravityview/view/wrapper_container",
"gravityview_datatables_button_labels",
"gravityview_datatables_js_options",
"gravityview_datatables_lengthmenu",
"gravityview_datatables_loading_text",
"gravityview_datatables_style_src",
"gravityview_dt_default_settings",
"gravityview_dt_rowgroup_script_src",
"gravityview_dt_rowgroup_style_src"
]
},
"hooks": [
{
"id": "gk-gravityview-datatables-output-before",
"name": "gk/gravityview/datatables/output/before",
"type": "action",
"product": "gravityview-datatables",
"description": "Runs before generating the output data.",
"parameters": [
{
"name": "entries",
"type": "\\GV\\Entry_Collection",
"description": "The collection of entries for the current search."
},
{
"name": "view",
"type": "\\View",
"description": "The View."
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "The current View or post/page where View is embedded."
}
],
"categories": [
"views",
"before"
],
"example": "add_action( 'gk/gravityview/datatables/output/before', function($entries, $view, $post) {\n // Your code here\n}, 10, 3 );",
"since": "[2.0](../../since/2-0/)",
"source": {
"file": "includes/class-datatables-data.php",
"line": 716
},
"url": "/docs/gravityview-datatables/actions/gk-gravityview-datatables-output-before/",
"related": []
},
{
"id": "gravityview_datatables_scripts_styles",
"name": "gravityview_datatables_scripts_styles",
"type": "action",
"product": "gravityview-datatables",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "empty_array_1",
"type": "array",
"description": "Empty array (deprecated)."
},
{
"name": "empty_array_2",
"type": "array",
"description": "Empty array (deprecated)."
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "Current View or post/page where View is embedded."
}
],
"categories": [
"views",
"assets"
],
"example": "add_action( 'gravityview_datatables_scripts_styles', function($empty_array_1, $empty_array_2, $post) {\n // Your code here\n}, 10, 3 );",
"since": "[1.0](../../since/1-0/)",
"source": {
"file": "includes/class-datatables-data.php",
"line": 1573
},
"url": "/docs/gravityview-datatables/actions/gravityview_datatables_scripts_styles/",
"related": []
},
{
"id": "gravityview_datatables_settings_row",
"name": "gravityview_datatables_settings_row",
"type": "action",
"product": "gravityview-datatables",
"description": "Fires after the DataTables settings metabox content is rendered.",
"parameters": [
{
"name": "ds",
"type": "array",
"description": "DataTables settings merged with defaults."
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "The View post object being edited."
}
],
"categories": [
"views"
],
"example": "add_action( 'gravityview_datatables_settings_row', function($ds, $post) {\n // Your code here\n}, 10, 2 );",
"since": "[1.0](../../since/1-0/)",
"source": {
"file": "includes/class-admin-datatables.php",
"line": 135
},
"url": "/docs/gravityview-datatables/actions/gravityview_datatables_settings_row/",
"related": []
},
{
"id": "gravityview-datatables-button",
"name": "gravityview/datatables/button",
"type": "filter",
"product": "gravityview-datatables",
"description": "Customise the button export options ( `type` is 'pdf', 'csv', 'excel', 'colvis' ).",
"parameters": [
{
"name": "button_config",
"type": "array",
"description": "Associative array of button options (mandatory 'extend' and 'text' (e.g. add pdf orientation with 'orientation' => 'landscape' )."
},
{
"name": "button",
"type": "string",
"description": "The button type."
},
{
"name": "view_id",
"type": "int",
"description": "View ID."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/datatables/button', function($button_config, $button, $view_id) {\n // Modify $button_config as needed\n return $button_config;\n}, 10, 3 );",
"since": "[2.0](../../since/2-0/)",
"source": {
"file": "includes/extensions/class-datatables-buttons.php",
"line": 227
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-button/",
"related": [
"gravityview/datatables/button_ . $button",
"gravityview/datatables/output"
]
},
{
"id": "gravityview-datatables-button_.button",
"name": "gravityview/datatables/button_ . $button",
"type": "filter",
"product": "gravityview-datatables",
"description": "Customise the button export options ( `type` is 'pdf', 'csv', 'excel', 'colvis' ).",
"parameters": [
{
"name": "button_config",
"type": "array",
"description": "Associative array of button options (mandatory 'extend' and 'text' (e.g. add pdf orientation with 'orientation' => 'landscape' )."
},
{
"name": "button",
"type": "string",
"description": "The button type."
},
{
"name": "view_id",
"type": "int",
"description": "View ID."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/datatables/button_ . $button', function($button_config, $button, $view_id) {\n // Modify $button_config as needed\n return $button_config;\n}, 10, 3 );",
"since": "[2.0](../../since/2-0/)",
"source": {
"file": "includes/extensions/class-datatables-buttons.php",
"line": 227
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-button_.button/",
"related": [
"gravityview/datatables/button",
"gravityview/datatables/output"
]
},
{
"id": "gravityview-datatables-config-language",
"name": "gravityview/datatables/config/language",
"type": "filter",
"product": "gravityview-datatables",
"description": "Override language settings",
"parameters": [
{
"name": "translations",
"type": "array",
"description": "The translations mapping array from GV_Extension_DataTables_Data::get_translations()"
},
{
"name": "locale",
"type": "string",
"description": "The blog's locale, fetched from get_locale() Override language settings"
},
{
"name": "language",
"type": "array",
"description": "The language settings array.\\n See a sample file with all available translations and their matching keys"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/datatables/config/language', function($translations, $locale, $language) {\n // Modify $translations as needed\n return $translations;\n}, 10, 3 );",
"since": "1.2.2: \\{@link https://github.com/DataTables/Plugins/blob/master/i18n/English.lang\\}",
"source": {
"file": "includes/class-datatables-data.php",
"line": 1097
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-config-language/",
"related": [
"gravityview/datatables/config/locale"
]
},
{
"id": "gravityview-datatables-config-locale",
"name": "gravityview/datatables/config/locale",
"type": "filter",
"product": "gravityview-datatables",
"description": "Change the locale used to fetch translations.",
"parameters": [
{
"name": "locale",
"type": "string",
"description": "The current locale."
},
{
"name": "translations",
"type": "array",
"description": "The translations mapping array."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/datatables/config/locale', function($locale, $translations) {\n // Modify $locale as needed\n return $locale;\n}, 10, 2 );",
"since": "[1.2.3](../../since/1-2-3/)",
"source": {
"file": "includes/class-datatables-data.php",
"line": 1035
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-config-locale/",
"related": [
"gravityview/datatables/config/language"
]
},
{
"id": "gravityview-datatables-field_filters-atts",
"name": "gravityview/datatables/field_filters/atts",
"type": "filter",
"product": "gravityview-datatables",
"description": "Modifies the attributes passed to the field filtering JS.",
"parameters": [
{
"name": "atts",
"type": "array",
"description": "The filter attributes."
},
{
"name": "field",
"type": "\\GV\\GF_Field|\\GV\\Internal_Field",
"description": "The field object."
},
{
"name": "form",
"type": "\\GF_Form",
"description": "The form object."
},
{
"name": "view",
"type": "\\View",
"description": "The view object."
}
],
"categories": [
"fields",
"search",
"views"
],
"example": "add_filter( 'gravityview/datatables/field_filters/atts', function($atts, $field, $form, $view) {\n // Modify $atts as needed\n return $atts;\n}, 10, 4 );",
"since": "[3.0](../../since/3-0/)",
"source": {
"file": "includes/class-datatables-field-filters.php",
"line": 368
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-field_filters-atts/",
"related": [
"gravityview/datatables/field_filters/placeholder"
]
},
{
"id": "gravityview-datatables-field_filters-placeholder",
"name": "gravityview/datatables/field_filters/placeholder",
"type": "filter",
"product": "gravityview-datatables",
"description": "Modifies the placeholder text used in the per-field filters.",
"parameters": [
{
"name": "filter_placeholder",
"type": "string",
"description": "The placeholder text."
},
{
"name": "field_label",
"type": "string",
"description": "The field label."
},
{
"name": "field",
"type": "\\GV\\GF_Field",
"description": "The field object."
},
{
"name": "form",
"type": "\\GF_Form",
"description": "The form object."
},
{
"name": "view",
"type": "\\View",
"description": "The view object."
}
],
"categories": [
"fields",
"search",
"views"
],
"example": "add_filter( 'gravityview/datatables/field_filters/placeholder', function($filter_placeholder, $field_label, $field, $form, $view) {\n // Modify $filter_placeholder as needed\n return $filter_placeholder;\n}, 10, 5 );",
"since": "[3.0](../../since/3-0/)",
"source": {
"file": "includes/class-datatables-field-filters.php",
"line": 354
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-field_filters-placeholder/",
"related": [
"gravityview/datatables/field_filters/atts"
]
},
{
"id": "gravityview-datatables-json-header-content_length",
"name": "gravityview/datatables/json/header/content_length",
"type": "filter",
"product": "gravityview-datatables",
"description": "Enable or disable the Content-Length header on the AJAX JSON response",
"parameters": [
{
"name": "has_content_length",
"type": "bool",
"description": "true by default"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/datatables/json/header/content_length', function($has_content_length) {\n // Modify $has_content_length as needed\n return $has_content_length;\n}, 10, 1 );",
"since": "[2.0](../../since/2-0/)",
"source": {
"file": "includes/class-datatables-data.php",
"line": 352
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-json-header-content_length/",
"related": []
},
{
"id": "gravityview-datatables-output-entry",
"name": "gravityview/datatables/output/entry",
"type": "filter",
"product": "gravityview-datatables",
"description": "Modify the entry output before the request is returned",
"parameters": [
{
"name": "temp",
"type": "array",
"description": "Array of values for the entry, one item per field being rendered by \\GV\\Field_Renderer()"
},
{
"name": "view",
"type": "\\View",
"description": "Current View being processed"
},
{
"name": "entry",
"type": "array",
"description": "Current Gravity Forms entry array"
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/datatables/output/entry', function($temp, $view, $entry) {\n // Modify $temp as needed\n return $temp;\n}, 10, 3 );",
"since": "[2.3.1](../../since/2-3-1/)",
"source": {
"file": "includes/class-datatables-data.php",
"line": 795
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-output-entry/",
"related": []
},
{
"id": "gravityview-datatables-output",
"name": "gravityview/datatables/output",
"type": "filter",
"product": "gravityview-datatables",
"description": "Filter the output returned from the AJAX request",
"parameters": [
{
"name": "dt_config",
"type": "array",
"description": "The DataTables configuration array."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View object."
},
{
"name": "entries",
"type": "\\GV\\Entry_Collection",
"description": "The entries collection."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/datatables/output', function($dt_config, $view, $entries) {\n // Modify $dt_config as needed\n return $dt_config;\n}, 10, 3 );",
"since": "[2.3](../../since/2-3/)",
"source": {
"file": "includes/class-datatables-processing-mode.php",
"line": 131
},
"url": "/docs/gravityview-datatables/filters/gravityview-datatables-output/",
"related": [
"gravityview/datatables/button",
"gravityview/datatables/button_ . $button"
]
},
{
"id": "gravityview-entry-cell-attributes",
"name": "gravityview/entry/cell/attributes",
"type": "filter",
"product": "gravityview-datatables",
"description": "Filter the row attributes for the row in table view.",
"parameters": [
{
"name": "attributes",
"type": "array",
"description": "The HTML attributes."
},
{
"name": "field",
"type": "\\GV\\Field",
"description": "The field these attributes are for."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "The entry this is being called for."
},
{
"name": "this",
"type": "\\GV\\View_Template",
"description": "This template."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry/cell/attributes', function($attributes, $field, $entry, $this) {\n // Modify $attributes as needed\n return $attributes;\n}, 10, 4 );",
"since": "[2.0](../../since/2-0/)",
"source": {
"file": "includes/class-gv-template-view-datatable.php",
"line": 155
},
"url": "/docs/gravityview-datatables/filters/gravityview-entry-cell-attributes/",
"related": []
},
{
"id": "gravityview-entry-row-attributes",
"name": "gravityview/entry/row/attributes",
"type": "filter",
"product": "gravityview-datatables",
"description": "Filter the row attributes for the row in table view.",
"parameters": [
{
"name": "attributes",
"type": "array",
"description": "The HTML attributes."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "The entry this is being called for."
},
{
"name": "this",
"type": "\\GV\\View_Template",
"description": "This template."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry/row/attributes', function($attributes, $entry, $this) {\n // Modify $attributes as needed\n return $attributes;\n}, 10, 3 );",
"since": "[2.0](../../since/2-0/)",
"source": {
"file": "includes/class-gv-template-view-datatable.php",
"line": 112
},
"url": "/docs/gravityview-datatables/filters/gravityview-entry-row-attributes/",
"related": []
},
{
"id": "gravityview-search-all-split-words",
"name": "gravityview/search-all-split-words",
"type": "filter",
"product": "gravityview-datatables",
"description": "Search for each word separately or the whole phrase?",
"parameters": [
{
"name": "split_words",
"type": "bool",
"description": "True: split a phrase into words; False: search whole word only [Default: true]"
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search-all-split-words', function($split_words) {\n // Modify $split_words as needed\n return $split_words;\n}, 10, 1 );",
"since": "[2.1.1](../../since/2-1-1/)",
"source": {
"file": "includes/class-datatables-data.php",
"line": 658
},
"url": "/docs/gravityview-datatables/filters/gravityview-search-all-split-words/",
"related": [
"gravityview/loaded",
"gravityview/comments_open",
"gravityview/is_single_entry",
"gravityview/logger",
"gravityview/show-settings-menu"
]
},
{
"id": "gravityview-view-wrapper_container",
"name": "gravityview/view/wrapper_container",
"type": "filter",
"product": "gravityview-datatables",
"description": "Modify the wrapper container HTML markup used to render the View.",
"parameters": [
{
"name": "wrapper_container",
"type": "string",
"description": "Wrapper container HTML markup."
},
{
"name": "anchor_id",
"type": "string",
"description": "Unique anchor ID to identify the View."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View being rendered."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/view/wrapper_container', function($wrapper_container, $anchor_id, $view) {\n // Modify $wrapper_container as needed\n return $wrapper_container;\n}, 10, 3 );",
"since": "[2.7](../../since/2-7/)",
"source": {
"file": "templates/views/datatable.php",
"line": 24
},
"url": "/docs/gravityview-datatables/filters/gravityview-view-wrapper_container/",
"related": [
"gravityview/view/get",
"gravityview/view/query",
"gravityview/view/anchor_id",
"gravityview/view/can_render",
"gravityview/view/entries"
]
},
{
"id": "gravityview_datatables_button_labels",
"name": "gravityview_datatables_button_labels",
"type": "filter",
"product": "gravityview-datatables",
"description": "Modify labels buttons",
"parameters": [
{
"name": "button_labels",
"type": "array",
"description": "Array of button types and their associated labels."
},
{
"name": "context",
"type": "string",
"description": "Where the labels are being shown. Allows for modifying the label for the View Settings vs frontend (default: \"admin\")."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_datatables_button_labels', function($button_labels, $context) {\n // Modify $button_labels as needed\n return $button_labels;\n}, 10, 2 );",
"since": "[2.4](../../since/2-4/)",
"source": {
"file": "includes/extensions/class-datatables-buttons.php",
"line": 109
},
"url": "/docs/gravityview-datatables/filters/gravityview_datatables_button_labels/",
"related": []
},
{
"id": "gravityview_datatables_js_options",
"name": "gravityview_datatables_js_options",
"type": "filter",
"product": "gravityview-datatables",
"description": "Modify the settings used to render DataTables.",
"parameters": [
{
"name": "dt_config",
"type": "array",
"description": "The configuration for the current View."
},
{
"name": "view_id",
"type": "int",
"description": "The ID of the View being configured."
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "Current View or post/page where View is embedded."
},
{
"name": "this",
"type": "\\GV_Extension_DataTables_Data",
"description": "The current instance of the class."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_datatables_js_options', function($dt_config, $view_id, $post, $this) {\n // Modify $dt_config as needed\n return $dt_config;\n}, 10, 4 );",
"since": "[1.0](../../since/1-0/)",
"source": {
"file": "includes/class-datatables-data.php",
"line": 1469
},
"url": "/docs/gravityview-datatables/filters/gravityview_datatables_js_options/",
"related": []
},
{
"id": "gravityview_datatables_lengthmenu",
"name": "gravityview_datatables_lengthmenu",
"type": "filter",
"product": "gravityview-datatables",
"description": "Modifies the values shown in the page length menu.",
"parameters": [
{
"name": "values",
"type": "array",
"description": "Array of values and labels for the page length menu."
},
{
"name": "view_data",
"type": "array",
"description": "The View data as an array [`\\GV\\View::as_data()`](../../../gravityview/api/classes/gv-view)."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_datatables_lengthmenu', function($values, $view_data) {\n // Modify $values as needed\n return $values;\n}, 10, 2 );",
"since": "[3.3.5](../../since/3-3-5/)",
"source": {
"file": "includes/class-datatables-data.php",
"line": 996
},
"url": "/docs/gravityview-datatables/filters/gravityview_datatables_lengthmenu/",
"related": []
},
{
"id": "gravityview_datatables_loading_text",
"name": "gravityview_datatables_loading_text",
"type": "filter",
"product": "gravityview-datatables",
"description": "Modify the text shown when DataTables is loaded",
"parameters": [
{
"name": "loading_text",
"type": "string",
"description": "Default: Loading data…"
},
{
"name": "view",
"type": "\\View",
"description": "The View"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_datatables_loading_text', function($loading_text, $view) {\n // Modify $loading_text as needed\n return $loading_text;\n}, 10, 2 );",
"since": "[2.5](../../since/2-5/): Added $view parameter",
"source": {
"file": "includes/class-datatables-data.php",
"line": 1074
},
"url": "/docs/gravityview-datatables/filters/gravityview_datatables_loading_text/",
"related": []
},
{
"id": "gravityview_datatables_style_src",
"name": "gravityview_datatables_style_src",
"type": "filter",
"product": "gravityview-datatables",
"description": "Override the GravityView datatables.css CSS file and provide your own",
"parameters": [
{
"name": "css_source",
"type": "string",
"description": "URL to the datatables.css file."
}
],
"categories": [
"views",
"assets"
],
"example": "add_filter( 'gravityview_datatables_style_src', function($css_source) {\n // Modify $css_source as needed\n return $css_source;\n}, 10, 1 );",
"since": "[1.0](../../since/1-0/)",
"source": {
"file": "includes/class-datatables-template.php",
"line": 42
},
"url": "/docs/gravityview-datatables/filters/gravityview_datatables_style_src/",
"related": []
},
{
"id": "gravityview_dt_default_settings",
"name": "gravityview_dt_default_settings",
"type": "filter",
"product": "gravityview-datatables",
"description": "Filters the default DataTables settings for a View.",
"parameters": [
{
"name": "defaults",
"type": "array",
"description": "Default settings array. Each extension should add its settings keys with default values."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_dt_default_settings', function($defaults) {\n // Modify $defaults as needed\n return $defaults;\n}, 10, 1 );",
"since": "[1.0](../../since/1-0/)",
"source": {
"file": "includes/class-admin-datatables.php",
"line": 120
},
"url": "/docs/gravityview-datatables/filters/gravityview_dt_default_settings/",
"related": []
},
{
"id": "gravityview_dt_rowgroup_script_src",
"name": "gravityview_dt_rowgroup_script_src",
"type": "filter",
"product": "gravityview-datatables",
"description": "Include RowGroup core script (DT plugin) Use your own DataTables core script by using the `gravityview_dt_rowgroup_script_src` filter",
"parameters": [
{
"name": "script_src",
"type": "string",
"description": "The URL to the RowGroup script file."
}
],
"categories": [
"views",
"assets"
],
"example": "add_filter( 'gravityview_dt_rowgroup_script_src', function($script_src) {\n // Modify $script_src as needed\n return $script_src;\n}, 10, 1 );",
"since": "[1.0](../../since/1-0/)",
"source": {
"file": "includes/extensions/class-datatables-rowgroup.php",
"line": 184
},
"url": "/docs/gravityview-datatables/filters/gravityview_dt_rowgroup_script_src/",
"related": []
},
{
"id": "gravityview_dt_rowgroup_style_src",
"name": "gravityview_dt_rowgroup_style_src",
"type": "filter",
"product": "gravityview-datatables",
"description": "Use your own RowGroup stylesheet by using the `gravityview_dt_rowgroup_style_src` filter",
"parameters": [
{
"name": "style_src",
"type": "string",
"description": "The URL to the RowGroup stylesheet file."
}
],
"categories": [
"views",
"assets"
],
"example": "add_filter( 'gravityview_dt_rowgroup_style_src', function($style_src) {\n // Modify $style_src as needed\n return $style_src;\n}, 10, 1 );",
"since": "[1.0](../../since/1-0/)",
"source": {
"file": "includes/extensions/class-datatables-rowgroup.php",
"line": 196
},
"url": "/docs/gravityview-datatables/filters/gravityview_dt_rowgroup_style_src/",
"related": []
}
],
"stats": {
"total": 24,
"actions": 3,
"filters": 21
}
}