",
"description": "The payload parts, keyed by part name."
},
{
"name": "view",
"type": "\\View",
"description": "The View being refreshed."
},
{
"name": "entries",
"type": "\\EntryCollection",
"description": "The entries the payload renders."
},
{
"name": "request",
"type": "\\Request",
"description": "The request context."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gk/gravityview/view/refresh/parts', function($parts, $view, $entries, $request) {\n // Modify $parts as needed\n return $parts;\n}, 10, 4 );",
"since": "3.5.0",
"source": {
"file": "src/View/ViewRefreshPayload.php",
"line": 155
},
"url": "/docs/gravityview/filters/gk-gravityview-view-refresh-parts/",
"related": [
"gk/gravityview/view/refresh/enabled",
"gk/gravityview/view/refresh/history",
"gk/gravityview/view/refresh/labels",
"gk/gravityview/view/refresh/live",
"gk/gravityview/view/refresh/max-page-size"
]
},
{
"id": "gk-gravityview-view-refresh-render-entries",
"name": "gk/gravityview/view/refresh/render-entries",
"type": "filter",
"product": "gravityview",
"description": "Filters whether the refresh payload renders the View.",
"parameters": [
{
"name": "render",
"type": "bool",
"description": "Whether to render the View. Default true."
},
{
"name": "view",
"type": "\\View",
"description": "The View being refreshed."
},
{
"name": "request",
"type": "\\Request",
"description": "The request context."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gk/gravityview/view/refresh/render-entries', function($render, $view, $request) {\n // Modify $render as needed\n return $render;\n}, 10, 3 );",
"since": "3.5.0",
"source": {
"file": "src/View/ViewRefreshPayload.php",
"line": 137
},
"url": "/docs/gravityview/filters/gk-gravityview-view-refresh-render-entries/",
"related": [
"gk/gravityview/view/refresh/enabled",
"gk/gravityview/view/refresh/history",
"gk/gravityview/view/refresh/labels",
"gk/gravityview/view/refresh/live",
"gk/gravityview/view/refresh/max-page-size"
]
},
{
"id": "gk-gravityview-view-refresh-validate",
"name": "gk/gravityview/view/refresh/validate",
"type": "filter",
"product": "gravityview",
"description": "Filters the validation result for a View refresh request.",
"parameters": [
{
"name": "error",
"type": "null\\",
"description": "\\WP_Error`"
},
{
"name": "view",
"type": "\\View",
"description": "The View being refreshed."
},
{
"name": "request",
"type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)",
"description": "The request."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gk/gravityview/view/refresh/validate', function($error, $view, $request) {\n // Modify $error as needed\n return $error;\n}, 10, 3 );",
"since": "3.5.0",
"source": {
"file": "src/REST/Controllers/ViewRefreshRoute.php",
"line": 159
},
"url": "/docs/gravityview/filters/gk-gravityview-view-refresh-validate/",
"related": [
"gk/gravityview/view/refresh/enabled",
"gk/gravityview/view/refresh/history",
"gk/gravityview/view/refresh/labels",
"gk/gravityview/view/refresh/live",
"gk/gravityview/view/refresh/max-page-size"
]
},
{
"id": "gk-gravityview-view-revisions-tracked-meta-keys",
"name": "gk/gravityview/view/revisions/tracked-meta-keys",
"type": "filter",
"product": "gravityview",
"description": "Filters the keys value.",
"parameters": [
{
"name": "keys",
"type": "string[]",
"description": "Default GravityView-owned meta keys."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gk/gravityview/view/revisions/tracked-meta-keys', function($keys) {\n // Modify $keys as needed\n return $keys;\n}, 10, 1 );",
"since": "3.0.0",
"source": {
"file": "src/View/Revisions.php",
"line": 81
},
"url": "/docs/gravityview/filters/gk-gravityview-view-revisions-tracked-meta-keys/",
"related": [
"gk/gravityview/view/revisions/restored"
]
},
{
"id": "gk-gravityview-view-secret-allow-legacy",
"name": "gk/gravityview/view/secret/allow-legacy",
"type": "filter",
"product": "gravityview",
"description": "Whether to accept a View's previous (pre per-site-key) secret.",
"parameters": [
{
"name": "allow_legacy",
"type": "bool",
"description": "Whether to accept the previous secret. Default: true only for pre-key Views."
},
{
"name": "view",
"type": "\\View",
"description": "The View being validated."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gk/gravityview/view/secret/allow-legacy', function($allow_legacy, $view) {\n // Modify $allow_legacy as needed\n return $allow_legacy;\n}, 10, 2 );",
"since": "3.1.0",
"source": {
"file": "src/View/View.php",
"line": 3251
},
"url": "/docs/gravityview/filters/gk-gravityview-view-secret-allow-legacy/",
"related": []
},
{
"id": "gk-gravityview-view-sorting-forced",
"name": "gk/gravityview/view/sorting/forced",
"type": "filter",
"product": "gravityview",
"description": "Filters whether visitor sorting is forced on for a View, whatever the View setting says.",
"parameters": [
{
"name": "forced",
"type": "bool",
"description": "Whether sorting is forced on. Default false."
},
{
"name": "view",
"type": "\\View",
"description": "The View."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gk/gravityview/view/sorting/forced', function($forced, $view) {\n // Modify $forced as needed\n return $forced;\n}, 10, 2 );",
"since": "3.5.0",
"source": {
"file": "src/Sorting/SortableColumns.php",
"line": 64
},
"url": "/docs/gravityview/filters/gk-gravityview-view-sorting-forced/",
"related": []
},
{
"id": "gk-gravityview-widget-search-clear-button-params",
"name": "gk/gravityview/widget/search/clear-button/params",
"type": "filter",
"product": "gravityview",
"description": "Modifies search widget's Clear button parameters.",
"parameters": [
{
"name": "clear_button_params",
"type": "array\\{url: string, text: string, view_id: int, atts: array\\}",
"description": "Clear button parameters."
}
],
"categories": [
"search",
"views",
"widgets"
],
"example": "add_filter( 'gk/gravityview/widget/search/clear-button/params', function($clear_button_params) {\n // Modify $clear_button_params as needed\n return $clear_button_params;\n}, 10, 1 );",
"since": "2.21",
"source": {
"file": "src/Widget/Search/templates/search-field-submit.php",
"line": 41
},
"url": "/docs/gravityview/filters/gk-gravityview-widget-search-clear-button-params/",
"related": []
},
{
"id": "gk-gravityview-widget-search-visible_fields_only",
"name": "gk/gravityview/widget/search/visible_fields_only",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"fields",
"search",
"views",
"widgets"
],
"example": "add_filter( 'gk/gravityview/widget/search/visible_fields_only', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/Policies/SearchFieldsPolicy.php",
"line": 101
},
"url": "/docs/gravityview/filters/gk-gravityview-widget-search-visible_fields_only/",
"related": []
},
{
"id": "gravitview_no_entries_text",
"name": "gravitview_no_entries_text",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "output",
"type": "string",
"description": "The existing \"No Entries\" text"
},
{
"name": "is_search",
"type": "bool",
"description": "Is the current page a search result, or just a multiple entries screen?"
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravitview_no_entries_text', function($output, $is_search) {\n // Modify $output as needed\n return $output;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/API/API.php",
"line": 437
},
"url": "/docs/gravityview/filters/gravitview_no_entries_text/",
"related": []
},
{
"id": "gravity_view_lightbox_script",
"name": "gravity_view_lightbox_script",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "script_slug",
"type": "string",
"description": "If you want to use a different lightbox script, return the name of it here."
}
],
"categories": [
"views",
"assets"
],
"example": "add_filter( 'gravity_view_lightbox_script', function($script_slug) {\n // Modify $script_slug as needed\n return $script_slug;\n}, 10, 1 );",
"since": null,
"source": {
"file": "tests/integration/Hooks/BC_Hooks_Test.php",
"line": 232
},
"url": "/docs/gravityview/filters/gravity_view_lightbox_script/",
"related": []
},
{
"id": "gravity_view_lightbox_style",
"name": "gravity_view_lightbox_style",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "script_slug",
"type": "string",
"description": "If you want to use a different lightbox script, return the name of its CSS file here."
}
],
"categories": [
"views",
"assets"
],
"example": "add_filter( 'gravity_view_lightbox_style', function($script_slug) {\n // Modify $script_slug as needed\n return $script_slug;\n}, 10, 1 );",
"since": null,
"source": {
"file": "tests/integration/Hooks/BC_Hooks_Test.php",
"line": 253
},
"url": "/docs/gravityview/filters/gravity_view_lightbox_style/",
"related": []
},
{
"id": "gravityview-admin-add_button_label",
"name": "gravityview/admin/add_button_label",
"type": "filter",
"product": "gravityview",
"description": "Filters the button label value.",
"parameters": [
{
"name": "button_label",
"type": "string",
"description": "Text for button: \"Add Widget\" or \"Add Field\""
},
{
"name": "atts",
"type": "array",
"description": "\\{"
}
],
"categories": [
"views",
"admin"
],
"example": "add_filter( 'gravityview/admin/add_button_label', function($button_label, $atts) {\n // Modify $button_label as needed\n return $button_label;\n}, 10, 2 );",
"since": "2.8.1",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 1549
},
"url": "/docs/gravityview/filters/gravityview-admin-add_button_label/",
"related": [
"gravityview/admin/available_fields",
"gravityview/admin/indicator_icons",
"gravityview/admin/notices"
]
},
{
"id": "gravityview-admin-available_fields",
"name": "gravityview/admin/available_fields",
"type": "filter",
"product": "gravityview",
"description": "Modify the available fields that can be used in a View.",
"parameters": [
{
"name": "fields",
"type": "array",
"description": "The fields."
},
{
"name": "form",
"type": "string\\",
"description": "array`"
},
{
"name": "zone",
"type": "string",
"description": "Either 'single', 'directory', 'header', 'footer'."
}
],
"categories": [
"fields",
"views",
"admin"
],
"example": "add_filter( 'gravityview/admin/available_fields', function($fields, $form, $zone) {\n // Modify $fields as needed\n return $fields;\n}, 10, 3 );",
"since": "2.10",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 1466
},
"url": "/docs/gravityview/filters/gravityview-admin-available_fields/",
"related": [
"gravityview/admin/add_button_label",
"gravityview/admin/indicator_icons",
"gravityview/admin/notices"
]
},
{
"id": "gravityview-admin-field-types-textarea-rows",
"name": "gravityview/admin/field-types/textarea/rows",
"type": "filter",
"product": "gravityview",
"description": "Filter the default number of rows for textarea fields in GravityView admin.",
"parameters": [
{
"name": "rows",
"type": "int",
"description": "The default number of rows. Default: 5."
}
],
"categories": [
"fields",
"views",
"admin"
],
"example": "add_filter( 'gravityview/admin/field-types/textarea/rows', function($rows) {\n // Modify $rows as needed\n return $rows;\n}, 10, 1 );",
"since": "1.22.5",
"source": {
"file": "src/Admin/FieldTypes/Textarea.php",
"line": 64
},
"url": "/docs/gravityview/filters/gravityview-admin-field-types-textarea-rows/",
"related": []
},
{
"id": "gravityview-admin-indicator_icons",
"name": "gravityview/admin/indicator_icons",
"type": "filter",
"product": "gravityview",
"description": "Modify the icon output to add additional indicator icons.",
"parameters": [
{
"name": "icons",
"type": "array",
"description": "Array of icons to be shown, with visible, title, css_class keys."
},
{
"name": "settings",
"type": "array",
"description": "Settings for the current item (widget or field)."
}
],
"categories": [
"views",
"admin"
],
"example": "add_filter( 'gravityview/admin/indicator_icons', function($icons, $settings) {\n // Modify $icons as needed\n return $icons;\n}, 10, 2 );",
"since": "2.10",
"source": {
"file": "src/Admin/ViewItem.php",
"line": 389
},
"url": "/docs/gravityview/filters/gravityview-admin-indicator_icons/",
"related": [
"gravityview/admin/add_button_label",
"gravityview/admin/available_fields",
"gravityview/admin/notices"
]
},
{
"id": "gravityview-admin-notices",
"name": "gravityview/admin/notices",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "notices",
"type": "array",
"description": "Array of notices to display."
}
],
"categories": [
"views",
"admin"
],
"example": "add_filter( 'gravityview/admin/notices', function($notices) {\n // Modify $notices as needed\n return $notices;\n}, 10, 1 );",
"since": "1.12",
"source": {
"file": "src/Admin/Notices.php",
"line": 206
},
"url": "/docs/gravityview/filters/gravityview-admin-notices/",
"related": [
"gravityview/admin/add_button_label",
"gravityview/admin/available_fields",
"gravityview/admin/indicator_icons"
]
},
{
"id": "gravityview-api-field-key",
"name": "gravityview/api/field/key",
"type": "filter",
"product": "gravityview",
"description": "Filter the key name in the results for JSON output.",
"parameters": [
{
"name": "field_id",
"type": "string",
"description": "The ID. Should be unique or keys will be gobbled up."
},
{
"name": "view",
"type": "\\View",
"description": "The View."
},
{
"name": "entry",
"type": "\\GravityKit\\GravityView\\Entry\\Entry",
"description": "The entry."
},
{
"name": "request",
"type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)",
"description": "Request object."
},
{
"name": "context",
"type": "string",
"description": "The context (directory, single)."
}
],
"categories": [
"fields",
"views",
"api"
],
"example": "add_filter( 'gravityview/api/field/key', function($field_id, $view, $entry, $request, $context) {\n // Modify $field_id as needed\n return $field_id;\n}, 10, 5 );",
"since": "2.10",
"source": {
"file": "src/REST/ViewsRoute.php",
"line": 222
},
"url": "/docs/gravityview/filters/gravityview-api-field-key/",
"related": []
},
{
"id": "gravityview-api-reserved_query_args",
"name": "gravityview/api/reserved_query_args",
"type": "filter",
"product": "gravityview",
"description": "Modify the URL arguments that should not be used because they are internal to GravityView.",
"parameters": [
{
"name": "reserved_args",
"type": "array",
"description": "Array of URL query keys that should not be used except internally."
}
],
"categories": [
"views",
"api"
],
"example": "add_filter( 'gravityview/api/reserved_query_args', function($reserved_args) {\n // Modify $reserved_args as needed\n return $reserved_args;\n}, 10, 1 );",
"since": "2.10",
"source": {
"file": "src/API/class-api.php",
"line": 82
},
"url": "/docs/gravityview/filters/gravityview-api-reserved_query_args/",
"related": []
},
{
"id": "gravityview-approve_entries-add-note",
"name": "gravityview/approve_entries/add-note",
"type": "filter",
"product": "gravityview",
"description": "Add a note when the entry has been approved or disapproved?",
"parameters": [
{
"name": "add_note",
"type": "bool",
"description": "True: Yep, add that note! False: Do not, under any circumstances, add that note!"
}
],
"categories": [
"entries",
"views",
"approval"
],
"example": "add_filter( 'gravityview/approve_entries/add-note', function($add_note) {\n // Modify $add_note as needed\n return $add_note;\n}, 10, 1 );",
"since": "1.16.3",
"source": {
"file": "src/Entry/Approval/Approval.php",
"line": 536
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-add-note/",
"related": [
"gravityview/approve_entries/ . $action",
"gravityview/approve_entries/updated",
"gravityview/approve_entries/after_submission",
"gravityview/approve_entries/bulk_actions",
"gravityview/approve_entries/hide-if-no-connections"
]
},
{
"id": "gravityview-approve_entries-after_submission-default_status",
"name": "gravityview/approve_entries/after_submission/default_status",
"type": "filter",
"product": "gravityview",
"description": "Modify the default approval status for newly submitted entries.",
"parameters": [
{
"name": "default_status",
"type": "int",
"description": "See GravityView_Entry_Approval_Status() for valid statuses."
}
],
"categories": [
"entries",
"views",
"approval",
"after"
],
"example": "add_filter( 'gravityview/approve_entries/after_submission/default_status', function($default_status) {\n // Modify $default_status as needed\n return $default_status;\n}, 10, 1 );",
"since": "2.0.14",
"source": {
"file": "src/Entry/Approval/Approval.php",
"line": 313
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-after_submission-default_status/",
"related": []
},
{
"id": "gravityview-approve_entries-after_submission",
"name": "gravityview/approve_entries/after_submission",
"type": "filter",
"product": "gravityview",
"description": "Modify whether to run the after_submission process.",
"parameters": [
{
"name": "process_after_submission",
"type": "bool",
"description": "Default: true."
}
],
"categories": [
"entries",
"views",
"approval",
"after"
],
"example": "add_filter( 'gravityview/approve_entries/after_submission', function($process_after_submission) {\n // Modify $process_after_submission as needed\n return $process_after_submission;\n}, 10, 1 );",
"since": "2.3",
"source": {
"file": "src/Entry/Approval/Approval.php",
"line": 298
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-after_submission/",
"related": [
"gravityview/approve_entries/ . $action",
"gravityview/approve_entries/updated",
"gravityview/approve_entries/add-note",
"gravityview/approve_entries/bulk_actions",
"gravityview/approve_entries/hide-if-no-connections"
]
},
{
"id": "gravityview-approve_entries-autounapprove-status",
"name": "gravityview/approve_entries/autounapprove/status",
"type": "filter",
"product": "gravityview",
"description": "Filters the approval status when an entry is auto-unapproved after editing.",
"parameters": [
{
"name": "approval_status",
"type": "int\\",
"description": "false`"
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form array."
},
{
"name": "entry_id",
"type": "string",
"description": "Numeric ID of the entry that was updated."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "Current View where the entry was edited."
}
],
"categories": [
"entries",
"views",
"approval"
],
"example": "add_filter( 'gravityview/approve_entries/autounapprove/status', function($approval_status, $form, $entry_id, $view) {\n // Modify $approval_status as needed\n return $approval_status;\n}, 10, 4 );",
"since": "2.2.2",
"source": {
"file": "src/Entry/Approval/Approval.php",
"line": 800
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-autounapprove-status/",
"related": []
},
{
"id": "gravityview-approve_entries-bulk_actions",
"name": "gravityview/approve_entries/bulk_actions",
"type": "filter",
"product": "gravityview",
"description": "Modify the GravityView \"Bulk action\" dropdown list. Return an empty array to hide.",
"parameters": [
{
"name": "bulk_actions",
"type": "array",
"description": "Associative array of actions to be added to \"Bulk action\" dropdown inside GravityView <optgroup>. Parent array key is the <optgroup> label, then each child array must have label (displayed text) and value (input value) keys"
},
{
"name": "form_id",
"type": "int",
"description": "ID of the form currently being displayed."
}
],
"categories": [
"entries",
"views",
"approval"
],
"example": "add_filter( 'gravityview/approve_entries/bulk_actions', function($bulk_actions, $form_id) {\n // Modify $bulk_actions as needed\n return $bulk_actions;\n}, 10, 2 );",
"since": "1.16.3",
"source": {
"file": "src/Entry/Approval/GFEntriesPageBulkActions.php",
"line": 234
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-bulk_actions/",
"related": [
"gravityview/approve_entries/ . $action",
"gravityview/approve_entries/updated",
"gravityview/approve_entries/add-note",
"gravityview/approve_entries/after_submission",
"gravityview/approve_entries/hide-if-no-connections"
]
},
{
"id": "gravityview-approve_entries-hide-if-no-connections",
"name": "gravityview/approve_entries/hide-if-no-connections",
"type": "filter",
"product": "gravityview",
"description": "Return true to hide reject/approve if there are no connected Views.",
"parameters": [
{
"name": "hide_if_no_connections",
"type": "bool",
"description": "Whether to hide the approval column when no Views are connected."
}
],
"categories": [
"entries",
"views",
"approval"
],
"example": "add_filter( 'gravityview/approve_entries/hide-if-no-connections', function($hide_if_no_connections) {\n // Modify $hide_if_no_connections as needed\n return $hide_if_no_connections;\n}, 10, 1 );",
"since": "1.7.2",
"source": {
"file": "src/Entry/Approval/EntriesList.php",
"line": 575
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-hide-if-no-connections/",
"related": [
"gravityview/approve_entries/ . $action",
"gravityview/approve_entries/updated",
"gravityview/approve_entries/add-note",
"gravityview/approve_entries/after_submission",
"gravityview/approve_entries/bulk_actions"
]
},
{
"id": "gravityview-approve_entries-popover_placement",
"name": "gravityview/approve_entries/popover_placement",
"type": "filter",
"product": "gravityview",
"description": "Where should the popover be placed?",
"parameters": [
{
"name": "placement",
"type": "string",
"description": "Where to place the popover; 'right' (default ltr), 'left' (default rtl), 'top', or 'bottom'."
}
],
"categories": [
"entries",
"views",
"approval"
],
"example": "add_filter( 'gravityview/approve_entries/popover_placement', function($placement) {\n // Modify $placement as needed\n return $placement;\n}, 10, 1 );",
"since": "2.3.1",
"source": {
"file": "src/Entry/Approval/Approval.php",
"line": 846
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-popover_placement/",
"related": [
"gravityview/approve_entries/ . $action",
"gravityview/approve_entries/updated",
"gravityview/approve_entries/add-note",
"gravityview/approve_entries/after_submission",
"gravityview/approve_entries/bulk_actions"
]
},
{
"id": "gravityview-approve_entries-show-column",
"name": "gravityview/approve_entries/show-column",
"type": "filter",
"product": "gravityview",
"description": "Override whether the column is shown.",
"parameters": [
{
"name": "show_approve_column",
"type": "bool",
"description": "Whether the column will be shown."
},
{
"name": "form_id",
"type": "int",
"description": "The ID of the Gravity Forms form for which entries are being shown."
}
],
"categories": [
"entries",
"views",
"approval"
],
"example": "add_filter( 'gravityview/approve_entries/show-column', function($show_approve_column, $form_id) {\n // Modify $show_approve_column as needed\n return $show_approve_column;\n}, 10, 2 );",
"since": "1.7.2",
"source": {
"file": "src/Entry/Approval/EntriesList.php",
"line": 594
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-show-column/",
"related": [
"gravityview/approve_entries/ . $action",
"gravityview/approve_entries/updated",
"gravityview/approve_entries/add-note",
"gravityview/approve_entries/after_submission",
"gravityview/approve_entries/bulk_actions"
]
},
{
"id": "gravityview-approve_entries-show_filter_links_entry_list",
"name": "gravityview/approve_entries/show_filter_links_entry_list",
"type": "filter",
"product": "gravityview",
"description": "Disable filter links.",
"parameters": [
{
"name": "show_filter_links",
"type": "bool",
"description": "True: show the \"approved\"/\"disapproved\" filter links. False: hide them."
},
{
"name": "form",
"type": "array",
"description": "GF Form object of current form."
}
],
"categories": [
"entries",
"search",
"views",
"approval"
],
"example": "add_filter( 'gravityview/approve_entries/show_filter_links_entry_list', function($show_filter_links, $form) {\n // Modify $show_filter_links as needed\n return $show_filter_links;\n}, 10, 2 );",
"since": "1.17.1",
"source": {
"file": "src/Entry/Approval/EntriesList.php",
"line": 119
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-show_filter_links_entry_list/",
"related": [
"gravityview/approve_entries/ . $action",
"gravityview/approve_entries/updated",
"gravityview/approve_entries/add-note",
"gravityview/approve_entries/after_submission",
"gravityview/approve_entries/bulk_actions"
]
},
{
"id": "gravityview-approve_entries-update_unapproved_meta",
"name": "gravityview/approve_entries/update_unapproved_meta",
"type": "filter",
"product": "gravityview",
"description": "Filters the approval status on entry update.",
"parameters": [
{
"name": "new_status",
"type": "string",
"description": "The approval status."
},
{
"name": "form",
"type": "array",
"description": "The form."
},
{
"name": "entry",
"type": "array",
"description": "The entry."
}
],
"categories": [
"entries",
"views",
"approval"
],
"example": "add_filter( 'gravityview/approve_entries/update_unapproved_meta', function($new_status, $form, $entry) {\n // Modify $new_status as needed\n return $new_status;\n}, 10, 3 );",
"since": "2.5",
"source": {
"file": "src/Entry/Approval/Approval.php",
"line": 377
},
"url": "/docs/gravityview/filters/gravityview-approve_entries-update_unapproved_meta/",
"related": [
"gravityview/approve_entries/ . $action",
"gravityview/approve_entries/updated",
"gravityview/approve_entries/add-note",
"gravityview/approve_entries/after_submission",
"gravityview/approve_entries/bulk_actions"
]
},
{
"id": "gravityview-capabilities-allow_logged_out",
"name": "gravityview/capabilities/allow_logged_out",
"type": "filter",
"product": "gravityview",
"description": "Shall we allow a cap check for non-logged in users? USE WITH CAUTION!",
"parameters": [
{
"name": "allow_logged_out",
"type": "bool",
"description": "Allow the capability check or bail without even checking. Default: false."
},
{
"name": "caps_to_check",
"type": "string\\",
"description": "array`"
},
{
"name": "object_id",
"type": "int\\",
"description": "null`"
},
{
"name": "user_id",
"type": "int\\",
"description": "null`"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/capabilities/allow_logged_out', function($allow_logged_out, $caps_to_check, $object_id, $user_id) {\n // Modify $allow_logged_out as needed\n return $allow_logged_out;\n}, 10, 4 );",
"since": "1.21.5.2",
"source": {
"file": "src/Permissions/RolesCapabilities.php",
"line": 387
},
"url": "/docs/gravityview/filters/gravityview-capabilities-allow_logged_out/",
"related": []
},
{
"id": "gravityview-comments_open",
"name": "gravityview/comments_open",
"type": "filter",
"product": "gravityview",
"description": "Whether to set comments to open or closed.",
"parameters": [
{
"name": "open",
"type": "bool",
"description": "Open or closed status"
},
{
"name": "post_id",
"type": "int",
"description": "Post ID to set comment status for"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/comments_open', function($open, $post_id) {\n // Modify $open as needed\n return $open;\n}, 10, 2 );",
"since": "1.5.4",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 873
},
"url": "/docs/gravityview/filters/gravityview-comments_open/",
"related": [
"gravityview/loaded",
"gravityview/is_single_entry",
"gravityview/logger",
"gravityview/search-all-split-words",
"gravityview/search-trim-input"
]
},
{
"id": "gravityview-common-get_entry-check_entry_display",
"name": "gravityview/common/get_entry/check_entry_display",
"type": "filter",
"product": "gravityview",
"description": "Override whether to check entry display rules against filters.",
"parameters": [
{
"name": "check_entry_display",
"type": "bool",
"description": "Check whether the entry is visible for the current View configuration. Default: true."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array."
},
{
"name": "view",
"type": "\\GV\\View|null",
"description": "The View."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/common/get_entry/check_entry_display', function($check_entry_display, $entry, $view) {\n // Modify $check_entry_display as needed\n return $check_entry_display;\n}, 10, 3 );",
"since": "1.16.2",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 977
},
"url": "/docs/gravityview/filters/gravityview-common-get_entry-check_entry_display/",
"related": []
},
{
"id": "gravityview-common-get_entry_id_from_slug-form_id",
"name": "gravityview/common/get_entry_id_from_slug/form_id",
"type": "filter",
"product": "gravityview",
"description": "The form ID used to get the custom entry ID. Change this to avoid collisions with data from other forms with the same values and the same field ID.",
"parameters": [
{
"name": "form_id",
"type": "int",
"description": "ID of the form to search. Default: 0 (searches all forms)."
}
],
"categories": [
"entries",
"views",
"forms"
],
"example": "add_filter( 'gravityview/common/get_entry_id_from_slug/form_id', function($form_id) {\n // Modify $form_id as needed\n return $form_id;\n}, 10, 1 );",
"since": "1.17.2",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 314
},
"url": "/docs/gravityview/filters/gravityview-common-get_entry_id_from_slug-form_id/",
"related": []
},
{
"id": "gravityview-common-get_form_fields",
"name": "gravityview/common/get_form_fields",
"type": "filter",
"product": "gravityview",
"description": "Modify the form fields shown in the Add Field field picker.",
"parameters": [
{
"name": "fields",
"type": "array",
"description": "Associative array of fields, with keys as field type, values an array with the following keys: (string) label (required), (string) type (required), desc, (string) customLabel, (GF_Field) parent, (string) adminLabel, (bool)adminOnly."
},
{
"name": "form",
"type": "array",
"description": "GF Form array."
},
{
"name": "include_parent_field",
"type": "bool",
"description": "Whether to include the parent field when getting a field with inputs."
}
],
"categories": [
"fields",
"views",
"forms"
],
"example": "add_filter( 'gravityview/common/get_form_fields', function($fields, $form, $include_parent_field) {\n // Modify $fields as needed\n return $fields;\n}, 10, 3 );",
"since": "1.17",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 613
},
"url": "/docs/gravityview/filters/gravityview-common-get_form_fields/",
"related": [
"gravityview/common/numeric_types",
"gravityview/common/sortable_fields"
]
},
{
"id": "gravityview-common-numeric_types",
"name": "gravityview/common/numeric_types",
"type": "filter",
"product": "gravityview",
"description": "What types of fields are numeric?",
"parameters": [
{
"name": "numeric_types",
"type": "array",
"description": "Fields that are numeric. Default: [ number, time ]."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/common/numeric_types', function($numeric_types) {\n // Modify $numeric_types as needed\n return $numeric_types;\n}, 10, 1 );",
"since": "1.5.2",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 1871
},
"url": "/docs/gravityview/filters/gravityview-common-numeric_types/",
"related": [
"gravityview/common/get_form_fields",
"gravityview/common/sortable_fields"
]
},
{
"id": "gravityview-common-sortable_fields",
"name": "gravityview/common/sortable_fields",
"type": "filter",
"product": "gravityview",
"description": "Filter the sortable fields.",
"parameters": [
{
"name": "fields",
"type": "array",
"description": "Sub-set of GF form fields that are sortable."
},
{
"name": "formid",
"type": "int",
"description": "The Gravity Forms form ID that the fields are from."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/common/sortable_fields', function($fields, $formid) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "1.12",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 1820
},
"url": "/docs/gravityview/filters/gravityview-common-sortable_fields/",
"related": [
"gravityview/common/get_form_fields",
"gravityview/common/numeric_types"
]
},
{
"id": "gravityview-configuration-fields",
"name": "gravityview/configuration/fields",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "fields",
"type": "mixed",
"description": "array Multi-array of fields with first level being the field zones."
},
{
"name": "view_id",
"type": "mixed",
"description": "int The View the fields are being pulled for."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/configuration/fields', function($fields, $view_id) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "1.6.5",
"source": {
"file": "src/View/View.php",
"line": 1411
},
"url": "/docs/gravityview/filters/gravityview-configuration-fields/",
"related": []
},
{
"id": "gravityview-csv-entry-fields",
"name": "gravityview/csv/entry/fields",
"type": "filter",
"product": "gravityview",
"description": "Allowlist more entry fields by ID that are output in CSV requests.",
"parameters": [
{
"name": "allowed",
"type": "array",
"description": "The allowed ones, default by_visible, byposition( \"context*\" ), i.e. as set in the View."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The view."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "WordPress representation of the item."
}
],
"categories": [
"entries",
"fields",
"views"
],
"example": "add_filter( 'gravityview/csv/entry/fields', function($allowed, $view, $entry) {\n // Modify $allowed as needed\n return $allowed;\n}, 10, 3 );",
"since": null,
"source": {
"file": "src/View/View.php",
"line": 2760
},
"url": "/docs/gravityview/filters/gravityview-csv-entry-fields/",
"related": []
},
{
"id": "gravityview-data-parse-meta_keys",
"name": "gravityview/data/parse/meta_keys",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/data/parse/meta_keys', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "tests/integration/Hooks/BC_Hooks_Test.php",
"line": 279
},
"url": "/docs/gravityview/filters/gravityview-data-parse-meta_keys/",
"related": []
},
{
"id": "gravityview-delete-entry-add_query_args",
"name": "gravityview/delete-entry/add_query_args",
"type": "filter",
"product": "gravityview",
"description": "Modify whether to include passed $_GET parameters to the end of the url.",
"parameters": [
{
"name": "add_query_params",
"type": "bool",
"description": "Whether to include passed $_GET parameters to the end of the Delete Link URL. Default: true."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/delete-entry/add_query_args', function($add_query_params) {\n // Modify $add_query_params as needed\n return $add_query_params;\n}, 10, 1 );",
"since": "2.10",
"source": {
"file": "src/Extension/DeleteEntry/DeleteEntry.php",
"line": 290
},
"url": "/docs/gravityview/filters/gravityview-delete-entry-add_query_args/",
"related": [
"gravityview/delete-entry/deleted",
"gravityview/delete-entry/trashed",
"gravityview/delete-entry/confirm-text",
"gravityview/delete-entry/delete-connected-post",
"gravityview/delete-entry/message"
]
},
{
"id": "gravityview-delete-entry-confirm-text",
"name": "gravityview/delete-entry/confirm-text",
"type": "filter",
"product": "gravityview",
"description": "Modify the Delete Entry Javascript confirmation text.",
"parameters": [
{
"name": "confirm",
"type": "string",
"description": "Default: \"Are you sure you want to delete this entry? This cannot be undone.\"."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/delete-entry/confirm-text', function($confirm) {\n // Modify $confirm as needed\n return $confirm;\n}, 10, 1 );",
"since": "1.10",
"source": {
"file": "src/Extension/DeleteEntry/DeleteEntry.php",
"line": 764
},
"url": "/docs/gravityview/filters/gravityview-delete-entry-confirm-text/",
"related": [
"gravityview/delete-entry/deleted",
"gravityview/delete-entry/trashed",
"gravityview/delete-entry/add_query_args",
"gravityview/delete-entry/delete-connected-post",
"gravityview/delete-entry/message"
]
},
{
"id": "gravityview-delete-entry-delete-connected-post",
"name": "gravityview/delete-entry/delete-connected-post",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "delete_post",
"type": "bool",
"description": "If trashing an entry, trash the post. If deleting an entry, delete the post. Default: true."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/delete-entry/delete-connected-post', function($delete_post) {\n // Modify $delete_post as needed\n return $delete_post;\n}, 10, 1 );",
"since": "1.17",
"source": {
"file": "src/Extension/DeleteEntry/DeleteEntry.php",
"line": 670
},
"url": "/docs/gravityview/filters/gravityview-delete-entry-delete-connected-post/",
"related": [
"gravityview/delete-entry/deleted",
"gravityview/delete-entry/trashed",
"gravityview/delete-entry/add_query_args",
"gravityview/delete-entry/confirm-text",
"gravityview/delete-entry/message"
]
},
{
"id": "gravityview-delete-entry-message",
"name": "gravityview/delete-entry/message",
"type": "filter",
"product": "gravityview",
"description": "Modify the Delete Entry messages.",
"parameters": [
{
"name": "message",
"type": "string",
"description": "Message to be displayed."
},
{
"name": "status",
"type": "string",
"description": "Message status (error or success)."
},
{
"name": "message_from_url",
"type": "string",
"description": "The original error message, if any, without the \"There was an error deleting the entry:\" prefix."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/delete-entry/message', function($message, $status, $message_from_url) {\n // Modify $message as needed\n return $message;\n}, 10, 3 );",
"since": "1.13.1",
"source": {
"file": "src/Extension/DeleteEntry/DeleteEntry.php",
"line": 961
},
"url": "/docs/gravityview/filters/gravityview-delete-entry-message/",
"related": [
"gravityview/delete-entry/deleted",
"gravityview/delete-entry/trashed",
"gravityview/delete-entry/add_query_args",
"gravityview/delete-entry/confirm-text",
"gravityview/delete-entry/delete-connected-post"
]
},
{
"id": "gravityview-delete-entry-mode",
"name": "gravityview/delete-entry/mode",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "delete_mode",
"type": "string",
"description": "Delete mode: trash or delete. Default: delete."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/delete-entry/mode', function($delete_mode) {\n // Modify $delete_mode as needed\n return $delete_mode;\n}, 10, 1 );",
"since": "1.13.1",
"source": {
"file": "src/Extension/DeleteEntry/DeleteEntry.php",
"line": 529
},
"url": "/docs/gravityview/filters/gravityview-delete-entry-mode/",
"related": [
"gravityview/delete-entry/deleted",
"gravityview/delete-entry/trashed",
"gravityview/delete-entry/add_query_args",
"gravityview/delete-entry/confirm-text",
"gravityview/delete-entry/delete-connected-post"
]
},
{
"id": "gravityview-delete-entry-redirect-args",
"name": "gravityview/delete-entry/redirect-args",
"type": "filter",
"product": "gravityview",
"description": "Modify the query args added to the delete entry redirect.",
"parameters": [
{
"name": "delete_redirect_args",
"type": "array",
"description": "Array with _delete_nonce, message and status keys."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/delete-entry/redirect-args', function($delete_redirect_args) {\n // Modify $delete_redirect_args as needed\n return $delete_redirect_args;\n}, 10, 1 );",
"since": "2.9.2",
"source": {
"file": "src/Extension/DeleteEntry/DeleteEntry.php",
"line": 496
},
"url": "/docs/gravityview/filters/gravityview-delete-entry-redirect-args/",
"related": [
"gravityview/delete-entry/deleted",
"gravityview/delete-entry/trashed",
"gravityview/delete-entry/add_query_args",
"gravityview/delete-entry/confirm-text",
"gravityview/delete-entry/delete-connected-post"
]
},
{
"id": "gravityview-delete-entry-show-delete-button",
"name": "gravityview/delete-entry/show-delete-button",
"type": "filter",
"product": "gravityview",
"description": "Should the Delete button be shown in the Edit Entry screen?",
"parameters": [
{
"name": "show_delete_button",
"type": "bool",
"description": "Default: true."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/delete-entry/show-delete-button', function($show_delete_button) {\n // Modify $show_delete_button as needed\n return $show_delete_button;\n}, 10, 1 );",
"since": "1.10",
"source": {
"file": "src/Extension/DeleteEntry/DeleteEntry.php",
"line": 339
},
"url": "/docs/gravityview/filters/gravityview-delete-entry-show-delete-button/",
"related": [
"gravityview/delete-entry/deleted",
"gravityview/delete-entry/trashed",
"gravityview/delete-entry/add_query_args",
"gravityview/delete-entry/confirm-text",
"gravityview/delete-entry/delete-connected-post"
]
},
{
"id": "gravityview-delete-entry-verify_nonce",
"name": "gravityview/delete-entry/verify_nonce",
"type": "filter",
"product": "gravityview",
"description": "Override Delete Entry nonce validation. Return true to declare nonce valid.",
"parameters": [
{
"name": "valid",
"type": "int\\",
"description": "bool`"
},
{
"name": "nonce_key",
"type": "string",
"description": "Name of nonce action used in wp_verify_nonce(). The $GET['delete'] value holds the nonce value itself. Default: delete\\{entry_id\\}."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/delete-entry/verify_nonce', function($valid, $nonce_key) {\n // Modify $valid as needed\n return $valid;\n}, 10, 2 );",
"since": "1.15.2",
"source": {
"file": "src/Extension/DeleteEntry/DeleteEntry.php",
"line": 742
},
"url": "/docs/gravityview/filters/gravityview-delete-entry-verify_nonce/",
"related": [
"gravityview/delete-entry/deleted",
"gravityview/delete-entry/trashed",
"gravityview/delete-entry/add_query_args",
"gravityview/delete-entry/confirm-text",
"gravityview/delete-entry/delete-connected-post"
]
},
{
"id": "gravityview-duplicate-backend-enable",
"name": "gravityview/duplicate/backend/enable",
"type": "filter",
"product": "gravityview",
"description": "Disables the duplicate link on the backend.",
"parameters": [
{
"name": "enable",
"type": "bool",
"description": "True by default. Enabled."
},
{
"name": "form_id",
"type": "int",
"description": "The form ID."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/duplicate/backend/enable', function($enable, $form_id) {\n // Modify $enable as needed\n return $enable;\n}, 10, 2 );",
"since": "2.5.1",
"source": {
"file": "src/Extension/DuplicateEntry/DuplicateEntry.php",
"line": 908
},
"url": "/docs/gravityview/filters/gravityview-duplicate-backend-enable/",
"related": []
},
{
"id": "gravityview-duplicate-entry-confirm-text",
"name": "gravityview/duplicate-entry/confirm-text",
"type": "filter",
"product": "gravityview",
"description": "Modify the Duplicate Entry Javascript confirmation text (will be sanitized when output).",
"parameters": [
{
"name": "confirm",
"type": "string",
"description": "Default: \"Are you sure you want to duplicate this entry?\". If empty, disable confirmation dialog."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/duplicate-entry/confirm-text', function($confirm) {\n // Modify $confirm as needed\n return $confirm;\n}, 10, 1 );",
"since": "2.5",
"source": {
"file": "src/Extension/DuplicateEntry/DuplicateEntry.php",
"line": 688
},
"url": "/docs/gravityview/filters/gravityview-duplicate-entry-confirm-text/",
"related": [
"gravityview/duplicate-entry/duplicated",
"gravityview/duplicate-entry/message",
"gravityview/duplicate-entry/verify_nonce"
]
},
{
"id": "gravityview-duplicate-entry-message",
"name": "gravityview/duplicate-entry/message",
"type": "filter",
"product": "gravityview",
"description": "Modify the Duplicate Entry messages. Allows HTML; will not be further sanitized.",
"parameters": [
{
"name": "message",
"type": "string",
"description": "Message to be displayed, sanitized using esc_attr()."
},
{
"name": "status",
"type": "string",
"description": "Message status (error or success)."
},
{
"name": "message_from_url",
"type": "string",
"description": "The original error message, if any, without the \"There was an error duplicating the entry:\" prefix."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/duplicate-entry/message', function($message, $status, $message_from_url) {\n // Modify $message as needed\n return $message;\n}, 10, 3 );",
"since": "2.5",
"source": {
"file": "src/Extension/DuplicateEntry/DuplicateEntry.php",
"line": 879
},
"url": "/docs/gravityview/filters/gravityview-duplicate-entry-message/",
"related": [
"gravityview/duplicate-entry/duplicated",
"gravityview/duplicate-entry/confirm-text",
"gravityview/duplicate-entry/verify_nonce"
]
},
{
"id": "gravityview-duplicate-entry-verify_nonce",
"name": "gravityview/duplicate-entry/verify_nonce",
"type": "filter",
"product": "gravityview",
"description": "Override Duplicate Entry nonce validation. Return true to declare nonce valid.",
"parameters": [
{
"name": "valid",
"type": "int\\",
"description": "bool`"
},
{
"name": "nonce_key",
"type": "string",
"description": "Name of nonce action used in wp_verify_nonce(). The $GET['duplicate'] value holds the nonce value itself. Default: duplicate\\{entry_id\\}."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/duplicate-entry/verify_nonce', function($valid, $nonce_key) {\n // Modify $valid as needed\n return $valid;\n}, 10, 2 );",
"since": "2.5",
"source": {
"file": "src/Extension/DuplicateEntry/DuplicateEntry.php",
"line": 665
},
"url": "/docs/gravityview/filters/gravityview-duplicate-entry-verify_nonce/",
"related": [
"gravityview/duplicate-entry/duplicated",
"gravityview/duplicate-entry/confirm-text",
"gravityview/duplicate-entry/message"
]
},
{
"id": "gravityview-duplicate-view-copy-date",
"name": "gravityview/duplicate-view/copy-date",
"type": "filter",
"product": "gravityview",
"description": "When copying a View, should the date also be copied?",
"parameters": [
{
"name": "copy_date",
"type": "bool",
"description": "Whether the copy the date from the existing View. Default: false."
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "View being cloned."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/duplicate-view/copy-date', function($copy_date, $post) {\n // Modify $copy_date as needed\n return $copy_date;\n}, 10, 2 );",
"since": "1.6",
"source": {
"file": "src/Admin/DuplicateView.php",
"line": 175
},
"url": "/docs/gravityview/filters/gravityview-duplicate-view-copy-date/",
"related": [
"gravityview/duplicate-view/get_clone_view_link",
"gravityview/duplicate-view/new-view",
"gravityview/duplicate-view/status"
]
},
{
"id": "gravityview-duplicate-view-get_clone_view_link",
"name": "gravityview/duplicate-view/get_clone_view_link",
"type": "filter",
"product": "gravityview",
"description": "Modifies the Clone View URL that is generated.",
"parameters": [
{
"name": "clone_view_link",
"type": "string",
"description": "Link with admin_url(\"admin.php\"), plus the action query string."
},
{
"name": "view_id",
"type": "int",
"description": "View ID."
},
{
"name": "context",
"type": "string",
"description": "How to display the link. If \"display\", the URL is run through esc_html(). Default: display."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/duplicate-view/get_clone_view_link', function($clone_view_link, $view_id, $context) {\n // Modify $clone_view_link as needed\n return $clone_view_link;\n}, 10, 3 );",
"since": "1.6",
"source": {
"file": "src/Admin/DuplicateView.php",
"line": 335
},
"url": "/docs/gravityview/filters/gravityview-duplicate-view-get_clone_view_link/",
"related": [
"gravityview/duplicate-view/copy-date",
"gravityview/duplicate-view/new-view",
"gravityview/duplicate-view/status"
]
},
{
"id": "gravityview-duplicate-view-new-view",
"name": "gravityview/duplicate-view/new-view",
"type": "filter",
"product": "gravityview",
"description": "Modifies View configuration before creating the duplicated View.",
"parameters": [
{
"name": "new_view",
"type": "array",
"description": "Array of settings to be passed to wp_insert_post()."
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "View being cloned."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/duplicate-view/new-view', function($new_view, $post) {\n // Modify $new_view as needed\n return $new_view;\n}, 10, 2 );",
"since": "1.6",
"source": {
"file": "src/Admin/DuplicateView.php",
"line": 190
},
"url": "/docs/gravityview/filters/gravityview-duplicate-view-new-view/",
"related": [
"gravityview/duplicate-view/copy-date",
"gravityview/duplicate-view/get_clone_view_link",
"gravityview/duplicate-view/status"
]
},
{
"id": "gravityview-duplicate-view-status",
"name": "gravityview/duplicate-view/status",
"type": "filter",
"product": "gravityview",
"description": "Modify the default status for a new View. Return empty for the new View to inherit existing View status.",
"parameters": [
{
"name": "status",
"type": "string\\",
"description": "null`"
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "View being cloned."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/duplicate-view/status', function($status, $post) {\n // Modify $status as needed\n return $status;\n}, 10, 2 );",
"since": "1.6",
"source": {
"file": "src/Admin/DuplicateView.php",
"line": 150
},
"url": "/docs/gravityview/filters/gravityview-duplicate-view-status/",
"related": [
"gravityview/duplicate-view/copy-date",
"gravityview/duplicate-view/get_clone_view_link",
"gravityview/duplicate-view/new-view"
]
},
{
"id": "gravityview-edit-link",
"name": "gravityview/edit/link",
"type": "filter",
"product": "gravityview",
"description": "Filter the edit URL link.",
"parameters": [
{
"name": "url",
"type": "string",
"description": "The URL."
},
{
"name": "entry",
"type": "array",
"description": "The entry."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View."
},
{
"name": "post",
"type": "\\WP_Post\\",
"description": "null`"
}
],
"categories": [
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit/link', function($url, $entry, $view, $post) {\n // Modify $url as needed\n return $url;\n}, 10, 4 );",
"since": "2.10",
"source": {
"file": "src/Extension/EditEntry/EditEntry.php",
"line": 282
},
"url": "/docs/gravityview/filters/gravityview-edit-link/",
"related": []
},
{
"id": "gravityview-edit_entry-button_labels",
"name": "gravityview/edit_entry/button_labels",
"type": "filter",
"product": "gravityview",
"description": "Modify the cancel/submit buttons' labels.",
"parameters": [
{
"name": "labels",
"type": "array",
"description": "Default button labels associative array"
},
{
"name": "form",
"type": "array",
"description": "The Gravity Forms form"
},
{
"name": "entry",
"type": "array",
"description": "The Gravity Forms entry"
},
{
"name": "view_id",
"type": "int",
"description": "The current View ID"
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/button_labels', function($labels, $form, $entry, $view_id) {\n // Modify $labels as needed\n return $labels;\n}, 10, 4 );",
"since": "1.16.3",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 3697
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-button_labels/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick",
"gravityview/edit_entry/conditional_logic"
]
},
{
"id": "gravityview-edit_entry-cancel_link",
"name": "gravityview/edit_entry/cancel_link",
"type": "filter",
"product": "gravityview",
"description": "Modify the cancel button link URL.",
"parameters": [
{
"name": "back_link",
"type": "string",
"description": "Existing URL of the Cancel link"
},
{
"name": "form",
"type": "array",
"description": "The Gravity Forms form"
},
{
"name": "entry",
"type": "array",
"description": "The Gravity Forms entry"
},
{
"name": "view_id",
"type": "int",
"description": "The current View ID"
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/cancel_link', function($back_link, $form, $entry, $view_id) {\n // Modify $back_link as needed\n return $back_link;\n}, 10, 4 );",
"since": "1.11.1",
"source": {
"file": "src/Extension/EditEntry/views/form-buttons.php",
"line": 33
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-cancel_link/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_onclick",
"gravityview/edit_entry/conditional_logic"
]
},
{
"id": "gravityview-edit_entry-cancel_onclick",
"name": "gravityview/edit_entry/cancel_onclick",
"type": "filter",
"product": "gravityview",
"description": "Modify the JavaScript code that runs when the Cancel button is clicked.",
"parameters": [
{
"name": "cancel_onclick_js",
"type": "string",
"description": "The JavaScript to execute on Cancel button click."
},
{
"name": "form",
"type": "array",
"description": "The Gravity Forms form."
},
{
"name": "entry",
"type": "array",
"description": "The Gravity Forms entry."
},
{
"name": "view_id",
"type": "int",
"description": "The current View ID."
},
{
"name": "update_count",
"type": "int",
"description": "The number of pages to go back based on the # of updates to the edited form."
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/cancel_onclick', function($cancel_onclick_js, $form, $entry, $view_id, $update_count) {\n // Modify $cancel_onclick_js as needed\n return $cancel_onclick_js;\n}, 10, 5 );",
"since": "2.13.4",
"source": {
"file": "src/Extension/EditEntry/views/form-buttons.php",
"line": 119
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-cancel_onclick/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/conditional_logic"
]
},
{
"id": "gravityview-edit_entry-conditional_logic",
"name": "gravityview/edit_entry/conditional_logic",
"type": "filter",
"product": "gravityview",
"description": "Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?",
"parameters": [
{
"name": "use_conditional_logic",
"type": "bool",
"description": "True: Gravity Forms will show/hide fields just like in the original form; False: conditional logic will be disabled and fields will be shown based on configuration. Default: true"
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form"
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/conditional_logic', function($use_conditional_logic, $form) {\n // Modify $use_conditional_logic as needed\n return $use_conditional_logic;\n}, 10, 2 );",
"since": "1.9",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 3458
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-conditional_logic/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-field_blacklist",
"name": "gravityview/edit_entry/field_blacklist",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"entries",
"fields",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/field_blacklist', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Extension/EditEntry/EditEntry.php",
"line": 360
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-field_blacklist/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-field_blocklist",
"name": "gravityview/edit_entry/field_blocklist",
"type": "filter",
"product": "gravityview",
"description": "Array of fields that should not be displayed in Edit Entry.",
"parameters": [
{
"name": "fields",
"type": "string[]",
"description": "Array of field type or meta key names (eg: [ \"captcha\", \"payment_status\" ])."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array."
}
],
"categories": [
"entries",
"fields",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/field_blocklist', function($fields, $entry) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "1.20",
"source": {
"file": "src/Extension/EditEntry/EditEntry.php",
"line": 370
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-field_blocklist/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-field_value",
"name": "gravityview/edit_entry/field_value",
"type": "filter",
"product": "gravityview",
"description": "Change the value of an Edit Entry field, if needed.",
"parameters": [
{
"name": "field_value",
"type": "mixed",
"description": "field value used to populate the input"
},
{
"name": "field",
"type": "object",
"description": "Gravity Forms field object ( Class GF_Field )"
},
{
"name": "this",
"type": "\\GravityView_Edit_Entry_Render",
"description": "Current object"
}
],
"categories": [
"entries",
"fields",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/field_value', function($field_value, $field, $this) {\n // Modify $field_value as needed\n return $field_value;\n}, 10, 3 );",
"since": "1.11",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 2450
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-field_value/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-field_value_.field-type",
"name": "gravityview/edit_entry/field_value_ . $field->type",
"type": "filter",
"product": "gravityview",
"description": "Change the value of an Edit Entry field for a specific field type.",
"parameters": [
{
"name": "field_value",
"type": "mixed",
"description": "field value used to populate the input"
},
{
"name": "field",
"type": "[\\GF_Field](https://docs.gravityforms.com/gf_field/)",
"description": "Gravity Forms field object"
},
{
"name": "this",
"type": "\\GravityView_Edit_Entry_Render",
"description": "Current object"
}
],
"categories": [
"entries",
"fields",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/field_value_ . $field->type', function($field_value, $field, $this) {\n // Modify $field_value as needed\n return $field_value;\n}, 10, 3 );",
"since": "1.17",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 2461
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-field_value_.field-type/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-form_fields",
"name": "gravityview/edit_entry/form_fields",
"type": "filter",
"product": "gravityview",
"description": "Modify the fields displayed in Edit Entry form.",
"parameters": [
{
"name": "fields",
"type": "\\GF_Field[]",
"description": "Gravity Forms form fields"
},
{
"name": "edit_fields",
"type": "array\\",
"description": "null`"
},
{
"name": "form",
"type": "array",
"description": "GF Form array (fields key modified to have only fields configured to show in Edit Entry)"
},
{
"name": "view_id",
"type": "int",
"description": "View ID"
}
],
"categories": [
"entries",
"fields",
"editing",
"views",
"forms"
],
"example": "add_filter( 'gravityview/edit_entry/form_fields', function($fields, $edit_fields, $form, $view_id) {\n // Modify $fields as needed\n return $fields;\n}, 10, 4 );",
"since": "1.17",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 3047
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-form_fields/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-hide-coupon-fields",
"name": "gravityview/edit_entry/hide-coupon-fields",
"type": "filter",
"product": "gravityview",
"description": "Should Coupon fields be hidden in Edit Entry?",
"parameters": [
{
"name": "has_transaction_data",
"type": "bool",
"description": "If true (the Entry has transaction data), hide the fields. Otherwise (false), show the Coupon field"
}
],
"categories": [
"entries",
"fields",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/hide-coupon-fields', function($has_transaction_data) {\n // Modify $has_transaction_data as needed\n return $has_transaction_data;\n}, 10, 1 );",
"since": "1.20",
"source": {
"file": "src/Integration/GravityFormsCoupon.php",
"line": 56
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-hide-coupon-fields/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-hide-product-fields",
"name": "gravityview/edit_entry/hide-product-fields",
"type": "filter",
"product": "gravityview",
"description": "Hide product fields from being editable.",
"parameters": [
{
"name": "hide_product_fields",
"type": "bool",
"description": "Whether to hide product fields in the editor. Uses $entry data to determine."
}
],
"categories": [
"entries",
"fields",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/hide-product-fields', function($hide_product_fields) {\n // Modify $hide_product_fields as needed\n return $hide_product_fields;\n}, 10, 1 );",
"since": "1.9.1",
"source": {
"file": "src/Field/Types/Product.php",
"line": 122
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-hide-product-fields/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-no_post_text",
"name": "gravityview/edit_entry/no_post_text",
"type": "filter",
"product": "gravityview",
"description": "Modify the message when someone is editing an entry attached to a post that no longer exists.",
"parameters": [
{
"name": "message",
"type": "string",
"description": "The existing \"This field is not editable; the post no longer exists.\" text"
}
],
"categories": [
"entries",
"editing",
"views",
"after"
],
"example": "add_filter( 'gravityview/edit_entry/no_post_text', function($message) {\n // Modify $message as needed\n return $message;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 2288
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-no_post_text/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-page-success",
"name": "gravityview/edit_entry/page/success",
"type": "filter",
"product": "gravityview",
"description": "Modify the edit entry success message on pages.",
"parameters": [
{
"name": "entry_updated_message",
"type": "string",
"description": "Existing message"
},
{
"name": "view_id",
"type": "int",
"description": "View ID"
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array"
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/page/success', function($entry_updated_message, $view_id, $entry) {\n // Modify $entry_updated_message as needed\n return $entry_updated_message;\n}, 10, 3 );",
"since": "3.0.0",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 1938
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-page-success/",
"related": []
},
{
"id": "gravityview-edit_entry-post_categories-append",
"name": "gravityview/edit_entry/post_categories/append",
"type": "filter",
"product": "gravityview",
"description": "Should post categories be added to or replaced?",
"parameters": [
{
"name": "append",
"type": "bool",
"description": "If true, don't delete existing categories, just add on. If false, replace the categories with the submitted categories. Default: false."
}
],
"categories": [
"entries",
"editing",
"views",
"after"
],
"example": "add_filter( 'gravityview/edit_entry/post_categories/append', function($append) {\n // Modify $append as needed\n return $append;\n}, 10, 1 );",
"since": "1.17",
"source": {
"file": "src/Field/Types/PostCategory.php",
"line": 85
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-post_categories-append/",
"related": []
},
{
"id": "gravityview-edit_entry-post_content-wp_editor_settings",
"name": "gravityview/edit_entry/post_content/wp_editor_settings",
"type": "filter",
"product": "gravityview",
"description": "Modify the settings passed to the Post Content wp_editor().",
"parameters": [
{
"name": "editor_settings",
"type": "array",
"description": "Array of settings to be passed to wp_editor(). Note: there is also an additional value in the array: placeholder, added to the textarea HTML by GravityView."
}
],
"categories": [
"entries",
"editing",
"views",
"after"
],
"example": "add_filter( 'gravityview/edit_entry/post_content/wp_editor_settings', function($editor_settings) {\n // Modify $editor_settings as needed\n return $editor_settings;\n}, 10, 1 );",
"since": "1.7",
"source": {
"file": "src/Field/Types/PostContent.php",
"line": 82
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-post_content-wp_editor_settings/",
"related": []
},
{
"id": "gravityview-edit_entry-pre_populate-override",
"name": "gravityview/edit_entry/pre_populate/override",
"type": "filter",
"product": "gravityview",
"description": "Allow the pre-populated value to override saved value in Edit Entry form. By default, pre-populate mechanism only kicks on empty fields.",
"parameters": [
{
"name": "override",
"type": "bool",
"description": "Whether to override saved values with pre-populated values. Default: false."
},
{
"name": "field",
"type": "[\\GF_Field](https://docs.gravityforms.com/gf_field/)",
"description": "Gravity Forms field object."
}
],
"categories": [
"entries",
"editing",
"views",
"before"
],
"example": "add_filter( 'gravityview/edit_entry/pre_populate/override', function($override, $field) {\n // Modify $override as needed\n return $override;\n}, 10, 2 );",
"since": "1.13",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 2387
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-pre_populate-override/",
"related": []
},
{
"id": "gravityview-edit_entry-render_hidden_field",
"name": "gravityview/edit_entry/render_hidden_field",
"type": "filter",
"product": "gravityview",
"description": "Filters the render hidden field value.",
"parameters": [
{
"name": "render_hidden_field",
"type": "bool",
"description": "Whether to render this Hidden field in HTML. Default: true"
},
{
"name": "field",
"type": "[\\GF_Field](https://docs.gravityforms.com/gf_field/)",
"description": "The field to possibly remove"
}
],
"categories": [
"entries",
"fields",
"rendering",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/render_hidden_field', function($render_hidden_field, $field) {\n // Modify $render_hidden_field as needed\n return $render_hidden_field;\n}, 10, 2 );",
"since": "2.7",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 3111
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-render_hidden_field/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-restore_display_name",
"name": "gravityview/edit_entry/restore_display_name",
"type": "filter",
"product": "gravityview",
"description": "Whether display names should be restored to before updating an entry.",
"parameters": [
{
"name": "restore_display_name",
"type": "bool",
"description": "Restore Display Name? Default: true."
}
],
"categories": [
"entries",
"editing",
"views",
"api"
],
"example": "add_filter( 'gravityview/edit_entry/restore_display_name', function($restore_display_name) {\n // Modify $restore_display_name as needed\n return $restore_display_name;\n}, 10, 1 );",
"since": "1.14.4",
"source": {
"file": "src/Extension/EditEntry/EditEntryUserRegistration.php",
"line": 303
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-restore_display_name/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-reveal_hidden_field",
"name": "gravityview/edit_entry/reveal_hidden_field",
"type": "filter",
"product": "gravityview",
"description": "Convert Hidden fields into Text fields on Edit Entry.",
"parameters": [
{
"name": "reveal_hidden_field",
"type": "bool",
"description": "True: Convert the hidden field to text; False: Leave hidden."
},
{
"name": "field",
"type": "[\\GF_Field_Hidden](https://docs.gravityforms.com/gf_field_hidden/)",
"description": "The field in question."
}
],
"categories": [
"entries",
"fields",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/reveal_hidden_field', function($reveal_hidden_field, $field) {\n // Modify $reveal_hidden_field as needed\n return $reveal_hidden_field;\n}, 10, 2 );",
"since": "1.22.6",
"source": {
"file": "src/Field/Types/Hidden.php",
"line": 73
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-reveal_hidden_field/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-success",
"name": "gravityview/edit_entry/success",
"type": "filter",
"product": "gravityview",
"description": "Modify the edit entry success message (including the anchor link).",
"parameters": [
{
"name": "entry_updated_message",
"type": "string",
"description": "Existing message"
},
{
"name": "view_id",
"type": "int",
"description": "View ID"
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array"
},
{
"name": "back_link",
"type": "string",
"description": "URL to return to the original entry. @since 1.6"
},
{
"name": "redirect_url",
"type": "string\\",
"description": "null`"
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/success', function($entry_updated_message, $view_id, $entry, $back_link, $redirect_url) {\n // Modify $entry_updated_message as needed\n return $entry_updated_message;\n}, 10, 5 );",
"since": "1.5.4",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 1998
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-success/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-unset_hidden_field_values",
"name": "gravityview/edit_entry/unset_hidden_field_values",
"type": "filter",
"product": "gravityview",
"description": "Whether to delete values of fields hidden by conditional logic.",
"parameters": [
{
"name": "unset_hidden_field_values",
"type": "bool",
"description": "Default: true"
},
{
"name": "this",
"type": "\\GravityView_Edit_Entry_Render",
"description": "This object"
}
],
"categories": [
"entries",
"fields",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/unset_hidden_field_values', function($unset_hidden_field_values, $this) {\n // Modify $unset_hidden_field_values as needed\n return $unset_hidden_field_values;\n}, 10, 2 );",
"since": "1.22.2",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 1017
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-unset_hidden_field_values/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-unsupported_post_field_text",
"name": "gravityview/edit_entry/unsupported_post_field_text",
"type": "filter",
"product": "gravityview",
"description": "Modify the message when someone isn't able to edit a post.",
"parameters": [
{
"name": "message",
"type": "string",
"description": "The existing \"You don't have permission...\" text"
}
],
"categories": [
"entries",
"fields",
"editing",
"views",
"after"
],
"example": "add_filter( 'gravityview/edit_entry/unsupported_post_field_text', function($message) {\n // Modify $message as needed\n return $message;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 2295
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-unsupported_post_field_text/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-use_gf_admin_only_setting",
"name": "gravityview/edit_entry/use_gf_admin_only_setting",
"type": "filter",
"product": "gravityview",
"description": "When Edit tab isn't configured, should the Gravity Forms \"Admin Only\" field settings be used to control field display to non-admins? Default: true.",
"parameters": [
{
"name": "use_gf_adminonly_setting",
"type": "bool",
"description": "True: Hide field if set to Admin Only in GF and the user is not an admin. False: show field based on GV permissions, ignoring GF permissions."
},
{
"name": "form",
"type": "array",
"description": "GF Form array"
},
{
"name": "view_id",
"type": "int",
"description": "View ID"
}
],
"categories": [
"entries",
"editing",
"views",
"admin"
],
"example": "add_filter( 'gravityview/edit_entry/use_gf_admin_only_setting', function($use_gf_adminonly_setting, $form, $view_id) {\n // Modify $use_gf_adminonly_setting as needed\n return $use_gf_adminonly_setting;\n}, 10, 3 );",
"since": "1.9.1",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 3210
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-use_gf_admin_only_setting/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-user_can_edit_entry",
"name": "gravityview/edit_entry/user_can_edit_entry",
"type": "filter",
"product": "gravityview",
"description": "Modify whether user can edit an entry.",
"parameters": [
{
"name": "user_can_edit",
"type": "bool",
"description": "Can the current user edit the current entry? (Default: false)."
},
{
"name": "entry",
"type": "array\\",
"description": "\\WP_Error`"
},
{
"name": "view_id",
"type": "int",
"description": "ID of the View you want to check visibility against."
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/user_can_edit_entry', function($user_can_edit, $entry, $view_id) {\n // Modify $user_can_edit as needed\n return $user_can_edit;\n}, 10, 3 );",
"since": "1.10",
"source": {
"file": "src/Extension/EditEntry/EditEntry.php",
"line": 463
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-user_can_edit_entry/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-edit_entry-user_registration-config",
"name": "gravityview/edit_entry/user_registration/config",
"type": "filter",
"product": "gravityview",
"description": "Modify the User Registration Addon feed configuration.",
"parameters": [
{
"name": "config",
"type": "array",
"description": "Gravity Forms User Registration feed configuration for the form."
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form array."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry being edited."
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/user_registration/config', function($config, $form, $entry) {\n // Modify $config as needed\n return $config;\n}, 10, 3 );",
"since": "1.14",
"source": {
"file": "src/Extension/EditEntry/EditEntryUserRegistration.php",
"line": 204
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-user_registration-config/",
"related": [
"gravityview/edit_entry/user_registration/entry",
"gravityview/edit_entry/user_registration/preserve_role",
"gravityview/edit_entry/user_registration/restored_user",
"gravityview/edit_entry/user_registration/trigger_update"
]
},
{
"id": "gravityview-edit_entry-user_registration-entry",
"name": "gravityview/edit_entry/user_registration/entry",
"type": "filter",
"product": "gravityview",
"description": "Modify entry details before updating the user via User Registration add-on.",
"parameters": [
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry."
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form."
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/user_registration/entry', function($entry, $form) {\n // Modify $entry as needed\n return $entry;\n}, 10, 2 );",
"since": "1.11",
"source": {
"file": "src/Extension/EditEntry/EditEntryUserRegistration.php",
"line": 108
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-user_registration-entry/",
"related": [
"gravityview/edit_entry/user_registration/config",
"gravityview/edit_entry/user_registration/preserve_role",
"gravityview/edit_entry/user_registration/restored_user",
"gravityview/edit_entry/user_registration/trigger_update"
]
},
{
"id": "gravityview-edit_entry-user_registration-preserve_role",
"name": "gravityview/edit_entry/user_registration/preserve_role",
"type": "filter",
"product": "gravityview",
"description": "Keep the current user role or override with the role defined in the Create feed.",
"parameters": [
{
"name": "preserve_role",
"type": "bool",
"description": "Preserve current user role. Default: true."
},
{
"name": "config",
"type": "array",
"description": "Gravity Forms User Registration feed configuration for the form."
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form array."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry being edited."
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/user_registration/preserve_role', function($preserve_role, $config, $form, $entry) {\n // Modify $preserve_role as needed\n return $preserve_role;\n}, 10, 4 );",
"since": "1.15",
"source": {
"file": "src/Extension/EditEntry/EditEntryUserRegistration.php",
"line": 180
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-user_registration-preserve_role/",
"related": [
"gravityview/edit_entry/user_registration/config",
"gravityview/edit_entry/user_registration/entry",
"gravityview/edit_entry/user_registration/restored_user",
"gravityview/edit_entry/user_registration/trigger_update"
]
},
{
"id": "gravityview-edit_entry-user_registration-restored_user",
"name": "gravityview/edit_entry/user_registration/restored_user",
"type": "filter",
"product": "gravityview",
"description": "Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView.",
"parameters": [
{
"name": "restored_user",
"type": "[\\WP_User](https://developer.wordpress.org/reference/classes/wp_user/)",
"description": "The user with restored details about to be updated by wp_update_user()."
},
{
"name": "user_before_update",
"type": "[\\WP_User](https://developer.wordpress.org/reference/classes/wp_user/)",
"description": "The user before being updated by Gravity Forms User Registration."
},
{
"name": "user_after_update",
"type": "[\\WP_User](https://developer.wordpress.org/reference/classes/wp_user/)",
"description": "The user after being updated by Gravity Forms User Registration."
},
{
"name": "entry",
"type": "array",
"description": "The Gravity Forms entry that was just updated."
}
],
"categories": [
"entries",
"editing",
"views",
"api"
],
"example": "add_filter( 'gravityview/edit_entry/user_registration/restored_user', function($restored_user, $user_before_update, $user_after_update, $entry) {\n // Modify $restored_user as needed\n return $restored_user;\n}, 10, 4 );",
"since": "1.14",
"source": {
"file": "src/Extension/EditEntry/EditEntryUserRegistration.php",
"line": 345
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-user_registration-restored_user/",
"related": [
"gravityview/edit_entry/user_registration/config",
"gravityview/edit_entry/user_registration/entry",
"gravityview/edit_entry/user_registration/preserve_role",
"gravityview/edit_entry/user_registration/trigger_update"
]
},
{
"id": "gravityview-edit_entry-user_registration-trigger_update",
"name": "gravityview/edit_entry/user_registration/trigger_update",
"type": "filter",
"product": "gravityview",
"description": "Choose whether to update user information via User Registration add-on when an entry is updated.",
"parameters": [
{
"name": "trigger_update",
"type": "bool",
"description": "Whether to trigger update on user registration. Default: true."
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/user_registration/trigger_update', function($trigger_update) {\n // Modify $trigger_update as needed\n return $trigger_update;\n}, 10, 1 );",
"since": "1.11",
"source": {
"file": "src/Extension/EditEntry/EditEntryUserRegistration.php",
"line": 61
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-user_registration-trigger_update/",
"related": [
"gravityview/edit_entry/user_registration/config",
"gravityview/edit_entry/user_registration/entry",
"gravityview/edit_entry/user_registration/preserve_role",
"gravityview/edit_entry/user_registration/restored_user"
]
},
{
"id": "gravityview-edit_entry-verify_nonce",
"name": "gravityview/edit_entry/verify_nonce",
"type": "filter",
"product": "gravityview",
"description": "Override Edit Entry nonce validation. Return true to declare nonce valid.",
"parameters": [
{
"name": "valid",
"type": "int\\",
"description": "bool`"
},
{
"name": "nonce_field",
"type": "string",
"description": "Key used when validating submissions. Default: is_gv_edit_entry"
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview/edit_entry/verify_nonce', function($valid, $nonce_field) {\n // Modify $valid as needed\n return $valid;\n}, 10, 2 );",
"since": "1.13",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 3667
},
"url": "/docs/gravityview/filters/gravityview-edit_entry-verify_nonce/",
"related": [
"gravityview/edit_entry/after_update",
"gravityview/edit_entry/before_update",
"gravityview/edit_entry/button_labels",
"gravityview/edit_entry/cancel_link",
"gravityview/edit_entry/cancel_onclick"
]
},
{
"id": "gravityview-entry-duplicate-details",
"name": "gravityview/entry/duplicate/details",
"type": "filter",
"product": "gravityview",
"description": "Modify the new entry details before it's created.",
"parameters": [
{
"name": "row",
"type": "array",
"description": "The entry details."
},
{
"name": "entry",
"type": "array",
"description": "The original entry."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry/duplicate/details', function($row, $entry) {\n // Modify $row as needed\n return $row;\n}, 10, 2 );",
"since": "2.5",
"source": {
"file": "src/Extension/DuplicateEntry/DuplicateEntry.php",
"line": 566
},
"url": "/docs/gravityview/filters/gravityview-entry-duplicate-details/",
"related": [
"gravityview/entry/duplicate/meta"
]
},
{
"id": "gravityview-entry-duplicate-meta",
"name": "gravityview/entry/duplicate/meta",
"type": "filter",
"product": "gravityview",
"description": "Modify the new entry meta details.",
"parameters": [
{
"name": "save_this_meta",
"type": "array",
"description": "The duplicate meta. Use/add meta_key, meta_value, item_index."
},
{
"name": "row",
"type": "array",
"description": "The duplicated entry."
},
{
"name": "entry",
"type": "array",
"description": "The original entry."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry/duplicate/meta', function($save_this_meta, $row, $entry) {\n // Modify $save_this_meta as needed\n return $save_this_meta;\n}, 10, 3 );",
"since": "2.5",
"source": {
"file": "src/Extension/DuplicateEntry/DuplicateEntry.php",
"line": 605
},
"url": "/docs/gravityview/filters/gravityview-entry-duplicate-meta/",
"related": [
"gravityview/entry/duplicate/details"
]
},
{
"id": "gravityview-entry-list-after-link",
"name": "gravityview/entry-list/after-link",
"type": "filter",
"product": "gravityview",
"description": "Modify the content displayed after the entry link in an entry list.",
"parameters": [
{
"name": "item_output",
"type": "string",
"description": "The HTML output for the after_link content."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array."
},
{
"name": "this",
"type": "\\GravityView_Entry_List",
"description": "The current class instance."
}
],
"categories": [
"entries",
"views",
"after"
],
"example": "add_filter( 'gravityview/entry-list/after-link', function($item_output, $entry, $this) {\n // Modify $item_output as needed\n return $item_output;\n}, 10, 3 );",
"since": "1.7.2",
"source": {
"file": "src/Entry/EntryList.php",
"line": 318
},
"url": "/docs/gravityview/filters/gravityview-entry-list-after-link/",
"related": [
"gravityview/entry-list/item",
"gravityview/entry-list/link"
]
},
{
"id": "gravityview-entry-list-item",
"name": "gravityview/entry-list/item",
"type": "filter",
"product": "gravityview",
"description": "Modify each item's output in an entry list.",
"parameters": [
{
"name": "item_output",
"type": "string",
"description": "The HTML output for the item."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array."
},
{
"name": "this",
"type": "\\GravityView_Entry_List",
"description": "The current class instance."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry-list/item', function($item_output, $entry, $this) {\n // Modify $item_output as needed\n return $item_output;\n}, 10, 3 );",
"since": "1.7.2",
"source": {
"file": "src/Entry/EntryList.php",
"line": 336
},
"url": "/docs/gravityview/filters/gravityview-entry-list-item/",
"related": [
"gravityview/entry-list/after-link",
"gravityview/entry-list/link"
]
},
{
"id": "gravityview-entry-list-link",
"name": "gravityview/entry-list/link",
"type": "filter",
"product": "gravityview",
"description": "Filters the link to an entry in an entry list.",
"parameters": [
{
"name": "link",
"type": "string",
"description": "The entry link URL."
},
{
"name": "entry",
"type": "array",
"description": "The entry array."
},
{
"name": "this",
"type": "\\GravityView_Entry_List",
"description": "The current entry list object."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry-list/link', function($link, $entry, $this) {\n // Modify $link as needed\n return $link;\n}, 10, 3 );",
"since": "2.6",
"source": {
"file": "src/Entry/EntryList.php",
"line": 303
},
"url": "/docs/gravityview/filters/gravityview-entry-list-link/",
"related": [
"gravityview/entry-list/after-link",
"gravityview/entry-list/item"
]
},
{
"id": "gravityview-entry-permalink",
"name": "gravityview/entry/permalink",
"type": "filter",
"product": "gravityview",
"description": "The permalink of this entry.",
"parameters": [
{
"name": "permalink",
"type": "string",
"description": "The permalink."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "The entry we're retrieving it for."
},
{
"name": "view",
"type": "\\GV\\View|null",
"description": "The view context."
},
{
"name": "request",
"type": "\\GV\\Request",
"description": "The request context."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry/permalink', function($permalink, $entry, $view, $request) {\n // Modify $permalink as needed\n return $permalink;\n}, 10, 4 );",
"since": "2.0",
"source": {
"file": "src/Entry/Entry.php",
"line": 268
},
"url": "/docs/gravityview/filters/gravityview-entry-permalink/",
"related": [
"gravityview/entry/slug"
]
},
{
"id": "gravityview-entry-slug",
"name": "gravityview/entry/slug",
"type": "filter",
"product": "gravityview",
"description": "Modify the entry URL slug as needed.",
"parameters": [
{
"name": "entry_slug",
"type": "string",
"description": "The slug, sanitized with sanitize_title()"
},
{
"name": "this",
"type": "null|\\GV\\Entry",
"description": "The entry object."
},
{
"name": "view",
"type": "null|\\GV\\View",
"description": "The view object."
},
{
"name": "request",
"type": "null|\\GV\\Request",
"description": "The request."
},
{
"name": "track_directory",
"type": "bool",
"description": "Whether the directory is tracked."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry/slug', function($entry_slug, $this, $view, $request, $track_directory) {\n // Modify $entry_slug as needed\n return $entry_slug;\n}, 10, 5 );",
"since": "2.2.1",
"source": {
"file": "src/Entry/Entry.php",
"line": 306
},
"url": "/docs/gravityview/filters/gravityview-entry-slug/",
"related": [
"gravityview/entry/permalink"
]
},
{
"id": "gravityview-entry_link-add_query_args",
"name": "gravityview/entry_link/add_query_args",
"type": "filter",
"product": "gravityview",
"description": "Modify whether to include passed $_GET parameters to the end of the url.",
"parameters": [
{
"name": "add_query_params",
"type": "bool",
"description": "Whether to include passed $_GET parameters to the end of the Entry Link URL. Default: true."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry_link/add_query_args', function($add_query_params) {\n // Modify $add_query_params as needed\n return $add_query_params;\n}, 10, 1 );",
"since": "2.10",
"source": {
"file": "templates/fields/field-entry_link-html.php",
"line": 55
},
"url": "/docs/gravityview/filters/gravityview-entry_link-add_query_args/",
"related": []
},
{
"id": "gravityview-entry_notes-add_note",
"name": "gravityview/entry_notes/add_note",
"type": "filter",
"product": "gravityview",
"description": "Modify note values before added using GFFormsModel::add_note().",
"parameters": [
{
"name": "note",
"type": "array",
"description": "Array with lead_id, user_id, user_name, note, and note_type key value pairs."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry_notes/add_note', function($note) {\n // Modify $note as needed\n return $note;\n}, 10, 1 );",
"since": "1.15.2",
"source": {
"file": "src/Entry/EntryNotes.php",
"line": 99
},
"url": "/docs/gravityview/filters/gravityview-entry_notes-add_note/",
"related": [
"gravityview/entry_notes/get_notes"
]
},
{
"id": "gravityview-entry_notes-get_notes",
"name": "gravityview/entry_notes/get_notes",
"type": "filter",
"product": "gravityview",
"description": "Modify the notes array for an entry.",
"parameters": [
{
"name": "notes",
"type": "\\stdClass[]\\",
"description": "null`"
},
{
"name": "entry_id",
"type": "int",
"description": "Entry to get notes for."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/entry_notes/get_notes', function($notes, $entry_id) {\n // Modify $notes as needed\n return $notes;\n}, 10, 2 );",
"since": "1.15",
"source": {
"file": "src/Entry/EntryNotes.php",
"line": 200
},
"url": "/docs/gravityview/filters/gravityview-entry_notes-get_notes/",
"related": [
"gravityview/entry_notes/add_note"
]
},
{
"id": "gravityview-extension-search-input_type",
"name": "gravityview/extension/search/input_type",
"type": "filter",
"product": "gravityview",
"description": "Modify the search form input type based on field type.",
"parameters": [
{
"name": "input_type",
"type": "string",
"description": "Assign an input type according to the form field type. Defaults: boolean, multi, select, date, text"
},
{
"name": "field_type",
"type": "string",
"description": "Gravity Forms field type (also the name parameter of GravityView_Field classes)"
},
{
"name": "field_id",
"type": "string\\",
"description": "int\\"
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/extension/search/input_type', function($input_type, $field_type, $field_id) {\n // Modify $input_type as needed\n return $input_type;\n}, 10, 3 );",
"since": "1.2",
"source": {
"file": "src/Widget/Types/SearchWidget.php",
"line": 509
},
"url": "/docs/gravityview/filters/gravityview-extension-search-input_type/",
"related": [
"gravityview/extension/search/links_label",
"gravityview/extension/search/links_sep",
"gravityview/extension/search/select_default"
]
},
{
"id": "gravityview-extension-search-links_label",
"name": "gravityview/extension/search/links_label",
"type": "filter",
"product": "gravityview",
"description": "Changes the label for the \"Link\" search bar input type.",
"parameters": [
{
"name": "links_label",
"type": "string",
"description": "Default: Show only: if search field label is not set. Otherwise, search field label."
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/extension/search/links_label', function($links_label) {\n // Modify $links_label as needed\n return $links_label;\n}, 10, 1 );",
"since": "1.17: Use search field label as default value, if set. Before that, it was hard-coded to \"Show only:\".",
"source": {
"file": "src/Widget/Search/templates/search-field-link.php",
"line": 37
},
"url": "/docs/gravityview/filters/gravityview-extension-search-links_label/",
"related": [
"gravityview/extension/search/input_type",
"gravityview/extension/search/links_sep",
"gravityview/extension/search/select_default"
]
},
{
"id": "gravityview-extension-search-links_sep",
"name": "gravityview/extension/search/links_sep",
"type": "filter",
"product": "gravityview",
"description": "Changes what separates search bar \"Link\" input type links.",
"parameters": [
{
"name": "links_sep",
"type": "string",
"description": "Default: \" \\"
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/extension/search/links_sep', function($links_sep) {\n // Modify $links_sep as needed\n return $links_sep;\n}, 10, 1 );",
"since": "2.10",
"source": {
"file": "src/Widget/Search/templates/search-field-link.php",
"line": 46
},
"url": "/docs/gravityview/filters/gravityview-extension-search-links_sep/",
"related": [
"gravityview/extension/search/input_type",
"gravityview/extension/search/links_label",
"gravityview/extension/search/select_default"
]
},
{
"id": "gravityview-extension-search-select_default",
"name": "gravityview/extension/search/select_default",
"type": "filter",
"product": "gravityview",
"description": "Defines the text for the default option in a select (multi or single dropdown).",
"parameters": [
{
"name": "default_option",
"type": "string",
"description": "Default: — (—)."
},
{
"name": "field_type",
"type": "string",
"description": "Field type: \"select\" or \"multiselect\"."
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/extension/search/select_default', function($default_option, $field_type) {\n // Modify $default_option as needed\n return $default_option;\n}, 10, 2 );",
"since": "1.16.4",
"source": {
"file": "src/Widget/Search/templates/search-field-select.php",
"line": 39
},
"url": "/docs/gravityview/filters/gravityview-extension-search-select_default/",
"related": [
"gravityview/extension/search/input_type",
"gravityview/extension/search/links_label",
"gravityview/extension/search/links_sep"
]
},
{
"id": "gravityview-features-paged-edit",
"name": "gravityview/features/paged-edit",
"type": "filter",
"product": "gravityview",
"description": "Filters the enable paged edit value.",
"parameters": [
{
"name": "enable_paged_edit",
"type": "bool",
"description": "Should paged editing be supported?"
},
{
"name": "form",
"type": "array",
"description": "The current form connected to the entry being edited"
}
],
"categories": [
"editing",
"views"
],
"example": "add_filter( 'gravityview/features/paged-edit', function($enable_paged_edit, $form) {\n // Modify $enable_paged_edit as needed\n return $enable_paged_edit;\n}, 10, 2 );",
"since": "2.5",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 1898
},
"url": "/docs/gravityview/filters/gravityview-features-paged-edit/",
"related": []
},
{
"id": "gravityview-field-approval-css_url",
"name": "gravityview/field/approval/css_url",
"type": "filter",
"product": "gravityview",
"description": "URL to the Approval field CSS file.",
"parameters": [
{
"name": "style_url",
"type": "string",
"description": "Override to use your own CSS file, or return empty string to disable loading."
}
],
"categories": [
"fields",
"views",
"approval",
"assets"
],
"example": "add_filter( 'gravityview/field/approval/css_url', function($style_url) {\n // Modify $style_url as needed\n return $style_url;\n}, 10, 1 );",
"since": "1.19",
"source": {
"file": "src/Field/Types/EntryApproval.php",
"line": 298
},
"url": "/docs/gravityview/filters/gravityview-field-approval-css_url/",
"related": [
"gravityview/field/approval/load_scripts"
]
},
{
"id": "gravityview-field-checkbox-csv_separator",
"name": "gravityview/field/checkbox/csv_separator",
"type": "filter",
"product": "gravityview",
"description": "Modify the separator used for CSV display of checkbox values.",
"parameters": [
{
"name": "separator",
"type": "string",
"description": "The separator to use between values. Default: ', '."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array."
},
{
"name": "field",
"type": "[\\GF_Field](https://docs.gravityforms.com/gf_field/)",
"description": "Gravity Forms field object."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The template context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/checkbox/csv_separator', function($separator, $entry, $field, $gravityview) {\n // Modify $separator as needed\n return $separator;\n}, 10, 4 );",
"since": "2.19",
"source": {
"file": "src/Field/Types/Checkbox.php",
"line": 271
},
"url": "/docs/gravityview/filters/gravityview-field-checkbox-csv_separator/",
"related": []
},
{
"id": "gravityview-field-class",
"name": "gravityview/field/class",
"type": "filter",
"product": "gravityview",
"description": "Filter the field class about to be created from the configuration.",
"parameters": [
{
"name": "field_class",
"type": "string",
"description": "The field class about to be used."
},
{
"name": "configuration",
"type": "array",
"description": "The configuration as per \\GV\\Field::as_configuration()."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/class', function($field_class, $configuration) {\n // Modify $field_class as needed\n return $field_class;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Field/Field.php",
"line": 261
},
"url": "/docs/gravityview/filters/gravityview-field-class/",
"related": [
"gravityview/field/is_visible",
"gravityview/field/value"
]
},
{
"id": "gravityview-field-is_visible",
"name": "gravityview/field/is_visible",
"type": "filter",
"product": "gravityview",
"description": "Should this field be visible?",
"parameters": [
{
"name": "visible",
"type": "bool",
"description": "Visible or not, defaults to the set field capability requirement if defined."
},
{
"name": "field",
"type": "\\GV\\Field",
"description": "The field we're looking at."
},
{
"name": "view",
"type": "\\GV\\View|null",
"description": "A context view."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/is_visible', function($visible, $field, $view) {\n // Modify $visible as needed\n return $visible;\n}, 10, 3 );",
"since": "2.0",
"source": {
"file": "src/Field/Field.php",
"line": 451
},
"url": "/docs/gravityview/filters/gravityview-field-is_visible/",
"related": [
"gravityview/field/class",
"gravityview/field/value"
]
},
{
"id": "gravityview-field-notes-content",
"name": "gravityview/field/notes/content",
"type": "filter",
"product": "gravityview",
"description": "Modify the note content before rendering in the template.",
"parameters": [
{
"name": "note_content",
"type": "array",
"description": "Array of note content that will be replaced in template files."
},
{
"name": "note",
"type": "object",
"description": "Note object with id, user_id, date_created, value, note_type, user_name, user_email vars."
},
{
"name": "show_delete",
"type": "bool",
"description": "True: Notes are editable. False: no editing notes."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/notes/content', function($note_content, $note, $show_delete, $context) {\n // Modify $note_content as needed\n return $note_content;\n}, 10, 4 );",
"since": "1.17",
"source": {
"file": "src/Field/Types/Notes.php",
"line": 992
},
"url": "/docs/gravityview/filters/gravityview-field-notes-content/",
"related": [
"gravityview/field/notes/scripts",
"gravityview/field/notes/custom-email",
"gravityview/field/notes/email_content",
"gravityview/field/notes/emails",
"gravityview/field/notes/strings"
]
},
{
"id": "gravityview-field-notes-custom-email",
"name": "gravityview/field/notes/custom-email",
"type": "filter",
"product": "gravityview",
"description": "Whether to include a Custom Email option for users to define a custom email to mail notes to.",
"parameters": [
{
"name": "include_custom",
"type": "bool",
"description": "Default: true."
}
],
"categories": [
"fields",
"views",
"notifications"
],
"example": "add_filter( 'gravityview/field/notes/custom-email', function($include_custom) {\n // Modify $include_custom as needed\n return $include_custom;\n}, 10, 1 );",
"since": "1.17",
"source": {
"file": "src/Field/Types/Notes.php",
"line": 1206
},
"url": "/docs/gravityview/filters/gravityview-field-notes-custom-email/",
"related": [
"gravityview/field/notes/scripts",
"gravityview/field/notes/content",
"gravityview/field/notes/email_content",
"gravityview/field/notes/emails",
"gravityview/field/notes/strings"
]
},
{
"id": "gravityview-field-notes-email_content",
"name": "gravityview/field/notes/email_content",
"type": "filter",
"product": "gravityview",
"description": "Modify the values passed when sending a note email.",
"parameters": [
{
"name": "email_settings",
"type": "array",
"description": "Values being passed to the GVCommon::send_email() method: 'from', 'to', 'bcc', 'reply_to', 'subject', 'message', 'from_name', 'message_format', 'entry', 'email_footer'"
}
],
"categories": [
"fields",
"views",
"notifications"
],
"example": "add_filter( 'gravityview/field/notes/email_content', function($email_settings) {\n // Modify $email_settings as needed\n return $email_settings;\n}, 10, 1 );",
"since": "1.17",
"source": {
"file": "src/Field/Types/Notes.php",
"line": 1335
},
"url": "/docs/gravityview/filters/gravityview-field-notes-email_content/",
"related": [
"gravityview/field/notes/scripts",
"gravityview/field/notes/content",
"gravityview/field/notes/custom-email",
"gravityview/field/notes/emails",
"gravityview/field/notes/strings"
]
},
{
"id": "gravityview-field-notes-emails",
"name": "gravityview/field/notes/emails",
"type": "filter",
"product": "gravityview",
"description": "Modify the dropdown values displayed in the \"Also email note to\" dropdown.",
"parameters": [
{
"name": "note_emails",
"type": "array",
"description": "Array of email addresses connected to the entry."
},
{
"name": "entry",
"type": "array",
"description": "Current entry."
}
],
"categories": [
"fields",
"views",
"notifications"
],
"example": "add_filter( 'gravityview/field/notes/emails', function($note_emails, $entry) {\n // Modify $note_emails as needed\n return $note_emails;\n}, 10, 2 );",
"since": "1.17",
"source": {
"file": "src/Field/Types/Notes.php",
"line": 1169
},
"url": "/docs/gravityview/filters/gravityview-field-notes-emails/",
"related": [
"gravityview/field/notes/scripts",
"gravityview/field/notes/content",
"gravityview/field/notes/custom-email",
"gravityview/field/notes/email_content",
"gravityview/field/notes/strings"
]
},
{
"id": "gravityview-field-notes-strings",
"name": "gravityview/field/notes/strings",
"type": "filter",
"product": "gravityview",
"description": "Modify the strings used by the Entry Notes field.",
"parameters": [
{
"name": "strings",
"type": "array",
"description": "Text in key => value pairs"
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/notes/strings', function($strings) {\n // Modify $strings as needed\n return $strings;\n}, 10, 1 );",
"since": "1.17",
"source": {
"file": "src/Field/Types/Notes.php",
"line": 941
},
"url": "/docs/gravityview/filters/gravityview-field-notes-strings/",
"related": [
"gravityview/field/notes/scripts",
"gravityview/field/notes/content",
"gravityview/field/notes/custom-email",
"gravityview/field/notes/email_content",
"gravityview/field/notes/emails"
]
},
{
"id": "gravityview-field-notes-wpautop_email",
"name": "gravityview/field/notes/wpautop_email",
"type": "filter",
"product": "gravityview",
"description": "Should the message content have paragraphs added automatically, if using HTML message format.",
"parameters": [
{
"name": "wpautop_email",
"type": "bool",
"description": "True: Apply wpautop() to the email message if using; False: Leave as entered (Default: true)."
}
],
"categories": [
"fields",
"views",
"notifications"
],
"example": "add_filter( 'gravityview/field/notes/wpautop_email', function($wpautop_email) {\n // Modify $wpautop_email as needed\n return $wpautop_email;\n}, 10, 1 );",
"since": "1.18",
"source": {
"file": "src/Field/Types/Notes.php",
"line": 1360
},
"url": "/docs/gravityview/filters/gravityview-field-notes-wpautop_email/",
"related": [
"gravityview/field/notes/scripts",
"gravityview/field/notes/content",
"gravityview/field/notes/custom-email",
"gravityview/field/notes/email_content",
"gravityview/field/notes/emails"
]
},
{
"id": "gravityview-field-other_entries-args",
"name": "gravityview/field/other_entries/args",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"entries",
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/other_entries/args', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": "1.7.6",
"source": {
"file": "templates/deprecated/fields/other_entries.php",
"line": 81
},
"url": "/docs/gravityview/filters/gravityview-field-other_entries-args/",
"related": [
"gravityview/field/other_entries/criteria"
]
},
{
"id": "gravityview-field-other_entries-criteria",
"name": "gravityview/field/other_entries/criteria",
"type": "filter",
"product": "gravityview",
"description": "Modify the search parameters before the entries are fetched",
"parameters": [
{
"name": "criteria",
"type": "array",
"description": "Gravity Forms search criteria array, as used by GVCommon::get_entries()"
},
{
"name": "view_settings",
"type": "array",
"description": "Associative array of settings with plugin defaults used if not set by the View"
},
{
"name": "form_id",
"type": "int",
"description": "The Gravity Forms ID"
}
],
"categories": [
"entries",
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/other_entries/criteria', function($criteria, $view_settings, $form_id) {\n // Modify $criteria as needed\n return $criteria;\n}, 10, 3 );",
"since": "1.11",
"source": {
"file": "templates/deprecated/fields/other_entries.php",
"line": 55
},
"url": "/docs/gravityview/filters/gravityview-field-other_entries-criteria/",
"related": [
"gravityview/field/other_entries/args"
]
},
{
"id": "gravityview-field-quiz_percent-format",
"name": "gravityview/field/quiz_percent/format",
"type": "filter",
"product": "gravityview",
"description": "Modify the format of the display of Quiz Score (Percent) field.",
"parameters": [
{
"name": "format",
"type": "string",
"description": "Format passed to printf() function. Default %d%%, which prints as \"\\{number\\}%\". Notice the double %%, this prints a literal '%' character."
}
],
"categories": [
"fields",
"views",
"forms"
],
"example": "add_filter( 'gravityview/field/quiz_percent/format', function($format) {\n // Modify $format as needed\n return $format;\n}, 10, 1 );",
"since": null,
"source": {
"file": "templates/deprecated/fields/gquiz_percent.php",
"line": 22
},
"url": "/docs/gravityview/filters/gravityview-field-quiz_percent-format/",
"related": []
},
{
"id": "gravityview-field-this-type-value",
"name": "gravityview/field/\\{$this->type\\}/value",
"type": "filter",
"product": "gravityview",
"description": "Override the displayed value here.",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The value."
},
{
"name": "field",
"type": "\\GV\\Field",
"description": "The field we're doing this for."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The view for this context if applicable."
},
{
"name": "source",
"type": "\\GV\\Source",
"description": "The source (form) for this context if applicable."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "The entry for this context if applicable."
},
{
"name": "request",
"type": "\\GV\\Request",
"description": "The request for this context if applicable."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/\\{$this->type\\}/value', function($value, $field, $view, $source, $entry, $request) {\n // Modify $value as needed\n return $value;\n}, 10, 6 );",
"since": "2.0",
"source": {
"file": "src/Field/Field.php",
"line": 415
},
"url": "/docs/gravityview/filters/gravityview-field-this-type-value/",
"related": []
},
{
"id": "gravityview-field-value-empty",
"name": "gravityview/field/value/empty",
"type": "filter",
"product": "gravityview",
"description": "What to display when this field is empty.",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The value to display. Default: empty string."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The template context this is being called from."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/value/empty', function($value, $context) {\n // Modify $value as needed\n return $value;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Template/TemplateField.php",
"line": 357
},
"url": "/docs/gravityview/filters/gravityview-field-value-empty/",
"related": []
},
{
"id": "gravityview-field-value",
"name": "gravityview/field/value",
"type": "filter",
"product": "gravityview",
"description": "Override the displayed value here.",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The value."
},
{
"name": "field",
"type": "\\GV\\Field",
"description": "The field we're doing this for."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The view for this context if applicable."
},
{
"name": "source",
"type": "\\GV\\Source",
"description": "The source (form) for this context if applicable."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "The entry for this context if applicable."
},
{
"name": "request",
"type": "\\GV\\Request",
"description": "The request for this context if applicable."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field/value', function($value, $field, $view, $source, $entry, $request) {\n // Modify $value as needed\n return $value;\n}, 10, 6 );",
"since": "2.0",
"source": {
"file": "src/Field/Field.php",
"line": 430
},
"url": "/docs/gravityview/filters/gravityview-field-value/",
"related": [
"gravityview/field/class",
"gravityview/field/is_visible"
]
},
{
"id": "gravityview-field_output-args",
"name": "gravityview/field_output/args",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "args",
"type": "array",
"description": "Associative array; field and form is required."
},
{
"name": "passed_args",
"type": "array",
"description": "Original associative array with field data. field and form are required."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field_output/args', function($args, $passed_args, $context) {\n // Modify $args as needed\n return $args;\n}, 10, 3 );",
"since": "1.7",
"source": {
"file": "src/API/class-api.php",
"line": 978
},
"url": "/docs/gravityview/filters/gravityview-field_output-args/",
"related": [
"gravityview/field_output/close_tag",
"gravityview/field_output/html",
"gravityview/field_output/open_tag",
"gravityview/field_output/pre_html"
]
},
{
"id": "gravityview-field_output-close_tag",
"name": "gravityview/field_output/close_tag",
"type": "filter",
"product": "gravityview",
"description": "Modify the closing tags for the template content placeholders.",
"parameters": [
{
"name": "close_tag",
"type": "string",
"description": "Close tag for template content placeholders. Default: \\}\\}"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field_output/close_tag', function($close_tag, $context) {\n // Modify $close_tag as needed\n return $close_tag;\n}, 10, 2 );",
"since": "1.11",
"source": {
"file": "src/API/class-api.php",
"line": 1118
},
"url": "/docs/gravityview/filters/gravityview-field_output-close_tag/",
"related": [
"gravityview/field_output/args",
"gravityview/field_output/html",
"gravityview/field_output/open_tag",
"gravityview/field_output/pre_html"
]
},
{
"id": "gravityview-field_output-context-.tag",
"name": "gravityview/field_output/context/ . $tag",
"type": "filter",
"product": "gravityview",
"description": "Filters the value value.",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The content to be shown instead of the \\{\\{tag\\}\\} placeholder"
},
{
"name": "args",
"type": "array",
"description": "Arguments passed to the function"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field_output/context/ . $tag', function($value, $args, $context) {\n // Modify $value as needed\n return $value;\n}, 10, 3 );",
"since": "1.11",
"source": {
"file": "src/API/class-api.php",
"line": 1147
},
"url": "/docs/gravityview/filters/gravityview-field_output-context-.tag/",
"related": []
},
{
"id": "gravityview-field_output-html",
"name": "gravityview/field_output/html",
"type": "filter",
"product": "gravityview",
"description": "Modify field HTML output.",
"parameters": [
{
"name": "html",
"type": "string",
"description": "Existing HTML output"
},
{
"name": "args",
"type": "array",
"description": "Arguments passed to the function"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field_output/html', function($html, $args, $context) {\n // Modify $html as needed\n return $html;\n}, 10, 3 );",
"since": "2.0",
"source": {
"file": "src/API/class-api.php",
"line": 1171
},
"url": "/docs/gravityview/filters/gravityview-field_output-html/",
"related": [
"gravityview/field_output/args",
"gravityview/field_output/close_tag",
"gravityview/field_output/open_tag",
"gravityview/field_output/pre_html"
]
},
{
"id": "gravityview-field_output-open_tag",
"name": "gravityview/field_output/open_tag",
"type": "filter",
"product": "gravityview",
"description": "Modify the opening tags for the template content placeholders.",
"parameters": [
{
"name": "open_tag",
"type": "string",
"description": "Open tag for template content placeholders. Default: \\{\\{"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/field_output/open_tag', function($open_tag, $context) {\n // Modify $open_tag as needed\n return $open_tag;\n}, 10, 2 );",
"since": "1.11",
"source": {
"file": "src/API/class-api.php",
"line": 1108
},
"url": "/docs/gravityview/filters/gravityview-field_output-open_tag/",
"related": [
"gravityview/field_output/args",
"gravityview/field_output/close_tag",
"gravityview/field_output/html",
"gravityview/field_output/pre_html"
]
},
{
"id": "gravityview-field_output-pre_html",
"name": "gravityview/field_output/pre_html",
"type": "filter",
"product": "gravityview",
"description": "Allow Pre filtering of the HTML.",
"parameters": [
{
"name": "markup",
"type": "string",
"description": "The HTML for the markup"
},
{
"name": "args",
"type": "array",
"description": "All args for the field output"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views",
"before"
],
"example": "add_filter( 'gravityview/field_output/pre_html', function($markup, $args, $context) {\n // Modify $markup as needed\n return $markup;\n}, 10, 3 );",
"since": "1.11",
"source": {
"file": "src/API/class-api.php",
"line": 1092
},
"url": "/docs/gravityview/filters/gravityview-field_output-pre_html/",
"related": [
"gravityview/field_output/args",
"gravityview/field_output/close_tag",
"gravityview/field_output/html",
"gravityview/field_output/open_tag"
]
},
{
"id": "gravityview-fields-custom-content_after",
"name": "gravityview/fields/custom/content_after",
"type": "filter",
"product": "gravityview",
"description": "Modify Custom Content field output after Merge Tag variables get replaced, before shortcodes get processed.",
"parameters": [
{
"name": "content",
"type": "string",
"description": "HTML content of field"
}
],
"categories": [
"fields",
"views",
"after"
],
"example": "add_filter( 'gravityview/fields/custom/content_after', function($content) {\n // Modify $content as needed\n return $content;\n}, 10, 1 );",
"since": "1.6.2",
"source": {
"file": "templates/deprecated/fields/custom.php",
"line": 62
},
"url": "/docs/gravityview/filters/gravityview-fields-custom-content_after/",
"related": [
"gravityview/fields/custom/content_before",
"gravityview/fields/custom/decode_shortcodes",
"gravityview/fields/custom/entry",
"gravityview/fields/custom/form"
]
},
{
"id": "gravityview-fields-custom-content_before",
"name": "gravityview/fields/custom/content_before",
"type": "filter",
"product": "gravityview",
"description": "Modify Custom Content field output before Merge Tag processing.",
"parameters": [
{
"name": "content",
"type": "string",
"description": "HTML content of field"
}
],
"categories": [
"fields",
"views",
"before"
],
"example": "add_filter( 'gravityview/fields/custom/content_before', function($content) {\n // Modify $content as needed\n return $content;\n}, 10, 1 );",
"since": "1.6.2",
"source": {
"file": "templates/deprecated/fields/custom.php",
"line": 28
},
"url": "/docs/gravityview/filters/gravityview-fields-custom-content_before/",
"related": [
"gravityview/fields/custom/content_after",
"gravityview/fields/custom/decode_shortcodes",
"gravityview/fields/custom/entry",
"gravityview/fields/custom/form"
]
},
{
"id": "gravityview-fields-custom-decode_shortcodes",
"name": "gravityview/fields/custom/decode_shortcodes",
"type": "filter",
"product": "gravityview",
"description": "Decode brackets in shortcodes.",
"parameters": [
{
"name": "decode",
"type": "bool",
"description": "Enable/Disable decoding of brackets in the content (default: false)"
},
{
"name": "content",
"type": "string",
"description": "HTML content of field"
}
],
"categories": [
"fields",
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/fields/custom/decode_shortcodes', function($decode, $content) {\n // Modify $decode as needed\n return $decode;\n}, 10, 2 );",
"since": "1.16.5",
"source": {
"file": "templates/deprecated/fields/custom.php",
"line": 47
},
"url": "/docs/gravityview/filters/gravityview-fields-custom-decode_shortcodes/",
"related": [
"gravityview/fields/custom/content_after",
"gravityview/fields/custom/content_before",
"gravityview/fields/custom/entry",
"gravityview/fields/custom/form"
]
},
{
"id": "gravityview-fields-custom-entry",
"name": "gravityview/fields/custom/entry",
"type": "filter",
"product": "gravityview",
"description": "Modify entry being displayed.",
"parameters": [
{
"name": "entry",
"type": "array",
"description": "The current entry being displayed."
},
{
"name": "form",
"type": "array",
"description": "The current form the custom content is using."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The GravityView template context instance."
}
],
"categories": [
"entries",
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/custom/entry', function($entry, $form, $gravityview) {\n // Modify $entry as needed\n return $entry;\n}, 10, 3 );",
"since": "2.10.3",
"source": {
"file": "templates/fields/field-custom.php",
"line": 39
},
"url": "/docs/gravityview/filters/gravityview-fields-custom-entry/",
"related": [
"gravityview/fields/custom/content_after",
"gravityview/fields/custom/content_before",
"gravityview/fields/custom/decode_shortcodes",
"gravityview/fields/custom/form"
]
},
{
"id": "gravityview-fields-custom-form",
"name": "gravityview/fields/custom/form",
"type": "filter",
"product": "gravityview",
"description": "Modify form that content is being pulled from.",
"parameters": [
{
"name": "form",
"type": "array",
"description": "The current form the custom content is using."
},
{
"name": "entry",
"type": "array",
"description": "The current entry being displayed."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The GravityView template context instance."
}
],
"categories": [
"fields",
"views",
"forms"
],
"example": "add_filter( 'gravityview/fields/custom/form', function($form, $entry, $gravityview) {\n // Modify $form as needed\n return $form;\n}, 10, 3 );",
"since": "2.10.3",
"source": {
"file": "templates/fields/field-custom.php",
"line": 50
},
"url": "/docs/gravityview/filters/gravityview-fields-custom-form/",
"related": [
"gravityview/fields/custom/content_after",
"gravityview/fields/custom/content_before",
"gravityview/fields/custom/decode_shortcodes",
"gravityview/fields/custom/entry"
]
},
{
"id": "gravityview-fields-date-hide_epoch",
"name": "gravityview/fields/date/hide_epoch",
"type": "filter",
"product": "gravityview",
"description": "Whether to hide values that match the Unix Epoch date (1970-01-01) from the output.",
"parameters": [
{
"name": "hide_epoch",
"type": "bool",
"description": "True: hide values that are 1970-01-01. False: show the value. Default: true."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/date/hide_epoch', function($hide_epoch) {\n // Modify $hide_epoch as needed\n return $hide_epoch;\n}, 10, 1 );",
"since": null,
"source": {
"file": "templates/deprecated/fields/date.php",
"line": 25
},
"url": "/docs/gravityview/filters/gravityview-fields-date-hide_epoch/",
"related": []
},
{
"id": "gravityview-fields-fileupload-disable_link",
"name": "gravityview/fields/fileupload/disable_link",
"type": "filter",
"product": "gravityview",
"description": "Filter to alter the default behaviour of wrapping images (or image names) with a link to the content object.",
"parameters": [
{
"name": "disable_wrapped_link",
"type": "bool",
"description": "Whether to wrap the content with a link to the content object."
},
{
"name": "field_compat",
"type": "array",
"description": "Current GravityView field array."
},
{
"name": "context",
"type": "\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/fileupload/disable_link', function($disable_wrapped_link, $field_compat, $context) {\n // Modify $disable_wrapped_link as needed\n return $disable_wrapped_link;\n}, 10, 3 );",
"since": "1.5.1",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 489
},
"url": "/docs/gravityview/filters/gravityview-fields-fileupload-disable_link/",
"related": [
"gravityview/fields/fileupload/extension",
"gravityview/fields/fileupload/file_path",
"gravityview/fields/fileupload/files_array",
"gravityview/fields/fileupload/image_atts",
"gravityview/fields/fileupload/link_atts"
]
},
{
"id": "gravityview-fields-fileupload-extension",
"name": "gravityview/fields/fileupload/extension",
"type": "filter",
"product": "gravityview",
"description": "Modify the file extension before it's used in display logic.",
"parameters": [
{
"name": "extension",
"type": "string",
"description": "The extension of the file, as parsed by pathinfo()."
},
{
"name": "file_path",
"type": "string",
"description": "Path to the file uploaded by Gravity Forms."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/fileupload/extension', function($extension, $file_path) {\n // Modify $extension as needed\n return $extension;\n}, 10, 2 );",
"since": "2.13.5",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 589
},
"url": "/docs/gravityview/filters/gravityview-fields-fileupload-extension/",
"related": [
"gravityview/fields/fileupload/disable_link",
"gravityview/fields/fileupload/file_path",
"gravityview/fields/fileupload/files_array",
"gravityview/fields/fileupload/image_atts",
"gravityview/fields/fileupload/link_atts"
]
},
{
"id": "gravityview-fields-fileupload-file_path",
"name": "gravityview/fields/fileupload/file_path",
"type": "filter",
"product": "gravityview",
"description": "Modify the file path before generating a link to it.",
"parameters": [
{
"name": "file_path",
"type": "string",
"description": "Path to the file uploaded by Gravity Forms."
},
{
"name": "field_settings",
"type": "array",
"description": "Array of GravityView field settings."
},
{
"name": "context",
"type": "\\Template_Context",
"description": "The context."
},
{
"name": "index",
"type": "int",
"description": "The current index of the $file_paths array being processed."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/fileupload/file_path', function($file_path, $field_settings, $context, $index) {\n // Modify $file_path as needed\n return $file_path;\n}, 10, 4 );",
"since": "1.22.3",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 625
},
"url": "/docs/gravityview/filters/gravityview-fields-fileupload-file_path/",
"related": [
"gravityview/fields/fileupload/disable_link",
"gravityview/fields/fileupload/extension",
"gravityview/fields/fileupload/files_array",
"gravityview/fields/fileupload/image_atts",
"gravityview/fields/fileupload/link_atts"
]
},
{
"id": "gravityview-fields-fileupload-files_array",
"name": "gravityview/fields/fileupload/files_array",
"type": "filter",
"product": "gravityview",
"description": "Modify the files array.",
"parameters": [
{
"name": "output_arr",
"type": "array",
"description": "Associative array of files"
},
{
"name": "file_path",
"type": "string",
"description": "The path to the file as stored in Gravity Forms."
},
{
"name": "content",
"type": "string",
"description": "The generated output for the file."
},
{
"name": "field_compat",
"type": "array",
"description": "Current GravityView field array."
},
{
"name": "context",
"type": "\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/fileupload/files_array', function($output_arr, $file_path, $content, $field_compat, $context) {\n // Modify $output_arr as needed\n return $output_arr;\n}, 10, 5 );",
"since": "1.7",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 550
},
"url": "/docs/gravityview/filters/gravityview-fields-fileupload-files_array/",
"related": [
"gravityview/fields/fileupload/disable_link",
"gravityview/fields/fileupload/extension",
"gravityview/fields/fileupload/file_path",
"gravityview/fields/fileupload/image_atts",
"gravityview/fields/fileupload/link_atts"
]
},
{
"id": "gravityview-fields-fileupload-image_atts",
"name": "gravityview/fields/fileupload/image_atts",
"type": "filter",
"product": "gravityview",
"description": "Modify the default image attributes for uploaded images.",
"parameters": [
{
"name": "image_atts",
"type": "array",
"description": "Array of image attributes including src, class, alt, and width."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/fileupload/image_atts', function($image_atts) {\n // Modify $image_atts as needed\n return $image_atts;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 443
},
"url": "/docs/gravityview/filters/gravityview-fields-fileupload-image_atts/",
"related": [
"gravityview/fields/fileupload/disable_link",
"gravityview/fields/fileupload/extension",
"gravityview/fields/fileupload/file_path",
"gravityview/fields/fileupload/files_array",
"gravityview/fields/fileupload/link_atts"
]
},
{
"id": "gravityview-fields-fileupload-link_atts",
"name": "gravityview/fields/fileupload/link_atts",
"type": "filter",
"product": "gravityview",
"description": "Modify the link attributes for a file upload field.",
"parameters": [
{
"name": "link_atts",
"type": "array\\",
"description": "string`"
},
{
"name": "field_compat",
"type": "array",
"description": "Current GravityView field array."
},
{
"name": "context",
"type": "\\Template_Context",
"description": "The context."
},
{
"name": "additional_details",
"type": "array",
"description": "Array of additional details about the file."
},
{
"name": "file_path",
"type": "string",
"description": "URL to file."
},
{
"name": "insecure_file_path",
"type": "string",
"description": "URL to insecure file."
},
{
"name": "disable_lightbox",
"type": "bool",
"description": "Whether the lightbox is disabled."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/fileupload/link_atts', function($link_atts, $field_compat, $context, $additional_details, $file_path, $insecure_file_path, $disable_lightbox) {\n // Modify $link_atts as needed\n return $link_atts;\n}, 10, 7 );",
"since": "2.0: Added $context.",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 521
},
"url": "/docs/gravityview/filters/gravityview-fields-fileupload-link_atts/",
"related": [
"gravityview/fields/fileupload/disable_link",
"gravityview/fields/fileupload/extension",
"gravityview/fields/fileupload/file_path",
"gravityview/fields/fileupload/files_array",
"gravityview/fields/fileupload/image_atts"
]
},
{
"id": "gravityview-fields-fileupload-link_content",
"name": "gravityview/fields/fileupload/link_content",
"type": "filter",
"product": "gravityview",
"description": "Modify the link text (defaults to the file name).",
"parameters": [
{
"name": "content",
"type": "string",
"description": "The existing anchor content. Could be <img> tag, audio/video embed, or the file name."
},
{
"name": "field_compat",
"type": "array",
"description": "Current GravityView field array."
},
{
"name": "context",
"type": "\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/fileupload/link_content', function($content, $field_compat, $context) {\n // Modify $content as needed\n return $content;\n}, 10, 3 );",
"since": "1.7",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 503
},
"url": "/docs/gravityview/filters/gravityview-fields-fileupload-link_content/",
"related": [
"gravityview/fields/fileupload/disable_link",
"gravityview/fields/fileupload/extension",
"gravityview/fields/fileupload/file_path",
"gravityview/fields/fileupload/files_array",
"gravityview/fields/fileupload/image_atts"
]
},
{
"id": "gravityview-fields-gravatar-settings",
"name": "gravityview/fields/gravatar/settings",
"type": "filter",
"product": "gravityview",
"description": "Modify the Gravatar settings for the field.",
"parameters": [
{
"name": "settings",
"type": "array",
"description": "Settings passed to \\{@see \\get_avatar()\\} for parameters."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The template context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/gravatar/settings', function($settings, $gravityview) {\n // Modify $settings as needed\n return $settings;\n}, 10, 2 );",
"since": "2.8",
"source": {
"file": "templates/fields/field-gravatar-html.php",
"line": 37
},
"url": "/docs/gravityview/filters/gravityview-fields-gravatar-settings/",
"related": []
},
{
"id": "gravityview-fields-image_choice-image_markup",
"name": "gravityview/fields/image_choice/image_markup",
"type": "filter",
"product": "gravityview",
"description": "Overrides the image markup for the Image Choice field.",
"parameters": [
{
"name": "image_markup",
"type": "string",
"description": "The image markup."
},
{
"name": "choice",
"type": "array",
"description": "The choice array."
},
{
"name": "form",
"type": "array",
"description": "The current form array."
},
{
"name": "field",
"type": "[\\GF_Field_Select](https://docs.gravityforms.com/gf_field_select/)",
"description": "Gravity Forms Select field."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/image_choice/image_markup', function($image_markup, $choice, $form, $field) {\n // Modify $image_markup as needed\n return $image_markup;\n}, 10, 4 );",
"since": "2.31",
"source": {
"file": "src/Field/Types/ImageChoice.php",
"line": 132
},
"url": "/docs/gravityview/filters/gravityview-fields-image_choice-image_markup/",
"related": [
"gravityview/fields/image_choice/output_label"
]
},
{
"id": "gravityview-fields-image_choice-output_label",
"name": "gravityview/fields/image_choice/output_label",
"type": "filter",
"product": "gravityview",
"description": "Overrides whether to show the value or the label of an Image Choice field.",
"parameters": [
{
"name": "show_label",
"type": "bool",
"description": "True to display the label of the choice; false to display the value. Default is false."
},
{
"name": "entry",
"type": "array",
"description": "The Gravity Forms entry."
},
{
"name": "field",
"type": "\\GF_Field_Checkbox\\",
"description": "\\GF_Field_Radio`"
},
{
"name": "gravityview",
"type": "\\Template_Context",
"description": "The GravityView template context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/image_choice/output_label', function($show_label, $entry, $field, $gravityview) {\n // Modify $show_label as needed\n return $show_label;\n}, 10, 4 );",
"since": "2.31.0",
"source": {
"file": "templates/fields/field-image_choice-html.php",
"line": 56
},
"url": "/docs/gravityview/filters/gravityview-fields-image_choice-output_label/",
"related": [
"gravityview/fields/image_choice/image_markup"
]
},
{
"id": "gravityview-fields-list-column-format",
"name": "gravityview/fields/list/column-format",
"type": "filter",
"product": "gravityview",
"description": "Format of single list column output of a List field with Multiple Columns enabled.",
"parameters": [
{
"name": "format",
"type": "string",
"description": "html (for list), text (for CSV output)
"
}
],
"categories": [
"fields",
"views",
"forms"
],
"example": "add_filter( 'gravityview/fields/list/column-format', function($format) {\n // Modify $format as needed\n return $format;\n}, 10, 1 );",
"since": "1.14",
"source": {
"file": "templates/deprecated/fields/list.php",
"line": 28
},
"url": "/docs/gravityview/filters/gravityview-fields-list-column-format/",
"related": []
},
{
"id": "gravityview-fields-post_image-size",
"name": "gravityview/fields/post_image/size",
"type": "filter",
"product": "gravityview",
"description": "Modify what size is fetched for the post's Featured Image",
"parameters": [
{
"name": "size",
"type": "string",
"description": "The size to be fetched using wp_get_attachment_image_src() (default: 'large')"
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array"
}
],
"categories": [
"fields",
"views",
"after"
],
"example": "add_filter( 'gravityview/fields/post_image/size', function($size, $entry) {\n // Modify $size as needed\n return $size;\n}, 10, 2 );",
"since": null,
"source": {
"file": "templates/deprecated/fields/post_image.php",
"line": 48
},
"url": "/docs/gravityview/filters/gravityview-fields-post_image-size/",
"related": []
},
{
"id": "gravityview-fields-select-output_label",
"name": "gravityview/fields/select/output_label",
"type": "filter",
"product": "gravityview",
"description": "Override whether to show the value or the label of a Select field.",
"parameters": [
{
"name": "show_label",
"type": "bool",
"description": "True: Show the label of the Choice; False: show the value of the Choice. Default: false"
},
{
"name": "entry",
"type": "array",
"description": "GF Entry"
},
{
"name": "field",
"type": "[\\GF_Field_Select](https://docs.gravityforms.com/gf_field_select/)",
"description": "Gravity Forms Select field"
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/select/output_label', function($show_label, $entry, $field) {\n // Modify $show_label as needed\n return $show_label;\n}, 10, 3 );",
"since": "1.5.2",
"source": {
"file": "templates/deprecated/fields/select.php",
"line": 21
},
"url": "/docs/gravityview/filters/gravityview-fields-select-output_label/",
"related": []
},
{
"id": "gravityview-fields-textarea-allow_html",
"name": "gravityview/fields/textarea/allow_html",
"type": "filter",
"product": "gravityview",
"description": "Allow the following HTML tags and strip everything else.",
"parameters": [
{
"name": "allow_html",
"type": "bool",
"description": "Whether to allow rendering HTML submitted in the textarea field. If disabled, output will be escaped with esc_html(). Default: true."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The template context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/textarea/allow_html', function($allow_html, $gravityview) {\n // Modify $allow_html as needed\n return $allow_html;\n}, 10, 2 );",
"since": "2.8",
"source": {
"file": "templates/fields/field-textarea-html.php",
"line": 26
},
"url": "/docs/gravityview/filters/gravityview-fields-textarea-allow_html/",
"related": [
"gravityview/fields/textarea/allowed_kses"
]
},
{
"id": "gravityview-fields-textarea-allowed_kses",
"name": "gravityview/fields/textarea/allowed_kses",
"type": "filter",
"product": "gravityview",
"description": "Allow the following HTML tags and strip everything else.",
"parameters": [
{
"name": "allowed_html",
"type": "array\\",
"description": "string`"
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/fields/textarea/allowed_kses', function($allowed_html) {\n // Modify $allowed_html as needed\n return $allowed_html;\n}, 10, 1 );",
"since": "1.21.5.1",
"source": {
"file": "templates/deprecated/fields/textarea.php",
"line": 28
},
"url": "/docs/gravityview/filters/gravityview-fields-textarea-allowed_kses/",
"related": [
"gravityview/fields/textarea/allow_html"
]
},
{
"id": "gravityview-get_all_views-params",
"name": "gravityview/get_all_views/params",
"type": "filter",
"product": "gravityview",
"description": "Modify the parameters sent to get all views.",
"parameters": [
{
"name": "params",
"type": "array",
"description": "Array of parameters to pass to get_posts()."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/get_all_views/params', function($params) {\n // Modify $params as needed\n return $params;\n}, 10, 1 );",
"since": "1.10",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 177
},
"url": "/docs/gravityview/filters/gravityview-get_all_views-params/",
"related": []
},
{
"id": "gravityview-get_link-allowed_atts",
"name": "gravityview/get_link/allowed_atts",
"type": "filter",
"product": "gravityview",
"description": "Modify the attributes that are allowed to be used in generating links.",
"parameters": [
{
"name": "allowed_atts",
"type": "array",
"description": "Array of attributes allowed."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/get_link/allowed_atts', function($allowed_atts) {\n // Modify $allowed_atts as needed\n return $allowed_atts;\n}, 10, 1 );",
"since": "1.6",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 2016
},
"url": "/docs/gravityview/filters/gravityview-get_link-allowed_atts/",
"related": []
},
{
"id": "gravityview-get_users-.context",
"name": "gravityview/get_users/ . $context",
"type": "filter",
"product": "gravityview",
"description": "Modify the settings used to fetch users.",
"parameters": [
{
"name": "settings",
"type": "array",
"description": "Settings array, with number key defining the # of users to display."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/get_users/ . $context', function($settings) {\n // Modify $settings as needed\n return $settings;\n}, 10, 1 );",
"since": "1.8",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 2120
},
"url": "/docs/gravityview/filters/gravityview-get_users-.context/",
"related": []
},
{
"id": "gravityview-gvlogic-atts",
"name": "gravityview/gvlogic/atts",
"type": "filter",
"product": "gravityview",
"description": "Filter the logic attributes for the [gvlogic] shortcode.",
"parameters": [
{
"name": "atts",
"type": "array",
"description": "The logic attributes."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/gvlogic/atts', function($atts) {\n // Modify $atts as needed\n return $atts;\n}, 10, 1 );",
"since": "2.5",
"source": {
"file": "src/Shortcode/GVLogicShortcode.php",
"line": 382
},
"url": "/docs/gravityview/filters/gravityview-gvlogic-atts/",
"related": []
},
{
"id": "gravityview-inspector-extension_mount_classes",
"name": "gravityview/inspector/extension_mount_classes",
"type": "filter",
"product": "gravityview",
"description": "Filters the map of recognized extension-slot mount classes.",
"parameters": [],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/inspector/extension_mount_classes', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": "3.0.0",
"source": {
"file": "src/REST/InspectorRoute.php",
"line": 8375
},
"url": "/docs/gravityview/filters/gravityview-inspector-extension_mount_classes/",
"related": []
},
{
"id": "gravityview-internal-ignored_endpoints",
"name": "gravityview/internal/ignored_endpoints",
"type": "filter",
"product": "gravityview",
"description": "Filters during ignored endpoints processing.",
"parameters": [],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/internal/ignored_endpoints', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Frontend/Frontend.php",
"line": 418
},
"url": "/docs/gravityview/filters/gravityview-internal-ignored_endpoints/",
"related": []
},
{
"id": "gravityview-is_single_entry",
"name": "gravityview/is_single_entry",
"type": "filter",
"product": "gravityview",
"description": "Modify the entry that is being displayed.",
"parameters": [],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/is_single_entry', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": "1.6",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1779
},
"url": "/docs/gravityview/filters/gravityview-is_single_entry/",
"related": [
"gravityview/loaded",
"gravityview/comments_open",
"gravityview/logger",
"gravityview/search-all-split-words",
"gravityview/search-trim-input"
]
},
{
"id": "gravityview-lightbox-provider-.staticslug.-settings",
"name": "gravityview/lightbox/provider/ . static::$slug . /settings",
"type": "filter",
"product": "gravityview",
"description": "Modifies the settings for a lightbox provider.",
"parameters": [
{
"name": "settings",
"type": "array",
"description": "Default settings for the lightbox provider."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/lightbox/provider/ . static::$slug . /settings', function($settings) {\n // Modify $settings as needed\n return $settings;\n}, 10, 1 );",
"since": "2.4",
"source": {
"file": "src/Extension/Lightbox/LightboxProvider.php",
"line": 237
},
"url": "/docs/gravityview/filters/gravityview-lightbox-provider-.staticslug.-settings/",
"related": []
},
{
"id": "gravityview-logger",
"name": "gravityview/logger",
"type": "filter",
"product": "gravityview",
"description": "Filter the logger instance being used for logging.",
"parameters": [
{
"name": "logger",
"type": "\\GV\\Logger",
"description": "The logger instance."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/logger', function($logger) {\n // Modify $logger as needed\n return $logger;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Core/Core.php",
"line": 109
},
"url": "/docs/gravityview/filters/gravityview-logger/",
"related": [
"gravityview/loaded",
"gravityview/comments_open",
"gravityview/is_single_entry",
"gravityview/search-all-split-words",
"gravityview/search-trim-input"
]
},
{
"id": "gravityview-merge_tags-do_replace_variables",
"name": "gravityview/merge_tags/do_replace_variables",
"type": "filter",
"product": "gravityview",
"description": "Turn off merge tag variable replacements.",
"parameters": [
{
"name": "do_replace_variables",
"type": "bool",
"description": "True: yes, replace variables for this text; False: do not replace variables."
},
{
"name": "text",
"type": "string",
"description": "Text to replace variables in."
},
{
"name": "form",
"type": "array",
"description": "GF Form array."
},
{
"name": "entry",
"type": "array",
"description": "GF Entry array."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/merge_tags/do_replace_variables', function($do_replace_variables, $text, $form, $entry) {\n // Modify $do_replace_variables as needed\n return $do_replace_variables;\n}, 10, 4 );",
"since": "1.13",
"source": {
"file": "src/Renderer/MergeTags.php",
"line": 718
},
"url": "/docs/gravityview/filters/gravityview-merge_tags-do_replace_variables/",
"related": []
},
{
"id": "gravityview-merge_tags-get-esc_html-.property",
"name": "gravityview/merge_tags/get/esc_html/ . $property",
"type": "filter",
"product": "gravityview",
"description": "Filter whether to escape HTML in the \\{get\\} merge tag output.",
"parameters": [
{
"name": "esc_html",
"type": "bool",
"description": "Whether to esc_html() the value. Default: true."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/merge_tags/get/esc_html/ . $property', function($esc_html) {\n // Modify $esc_html as needed\n return $esc_html;\n}, 10, 1 );",
"since": "1.15",
"source": {
"file": "src/Renderer/MergeTags.php",
"line": 1134
},
"url": "/docs/gravityview/filters/gravityview-merge_tags-get-esc_html-.property/",
"related": []
},
{
"id": "gravityview-merge_tags-get-glue-",
"name": "gravityview/merge_tags/get/glue/",
"type": "filter",
"product": "gravityview",
"description": "Filter the glue string used to join array values from $_GET into a string.",
"parameters": [
{
"name": "glue",
"type": "string",
"description": "String used to implode() $_GET values. Default: ', '."
},
{
"name": "property",
"type": "string",
"description": "The current name of the $_GET parameter being combined."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/merge_tags/get/glue/', function($glue, $property) {\n // Modify $glue as needed\n return $glue;\n}, 10, 2 );",
"since": "1.15",
"source": {
"file": "src/Renderer/MergeTags.php",
"line": 1117
},
"url": "/docs/gravityview/filters/gravityview-merge_tags-get-glue-/",
"related": []
},
{
"id": "gravityview-merge_tags-get-value-.property",
"name": "gravityview/merge_tags/get/value/ . $property",
"type": "filter",
"product": "gravityview",
"description": "Filters the \\{get\\} merge tag replacement value before being used.",
"parameters": [
{
"name": "value",
"type": "string",
"description": "Value that will replace \\{get\\}."
},
{
"name": "text",
"type": "string",
"description": "Text that contains \\{get\\} (before replacement)."
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form array."
},
{
"name": "entry",
"type": "array",
"description": "Entry array."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/merge_tags/get/value/ . $property', function($value, $text, $form, $entry) {\n // Modify $value as needed\n return $value;\n}, 10, 4 );",
"since": "1.15",
"source": {
"file": "src/Renderer/MergeTags.php",
"line": 1148
},
"url": "/docs/gravityview/filters/gravityview-merge_tags-get-value-.property/",
"related": []
},
{
"id": "gravityview-merge_tags-modifiers-format",
"name": "gravityview/merge_tags/modifiers/format",
"type": "filter",
"product": "gravityview",
"description": "Filters the formatted value for unsupported field types using the :format modifier.",
"parameters": [
{
"name": "raw_value",
"type": "string",
"description": "The raw field value."
},
{
"name": "format",
"type": "string",
"description": "The format string from the modifier."
},
{
"name": "field",
"type": "[\\GF_Field](https://docs.gravityforms.com/gf_field/)",
"description": "The Gravity Forms field object."
},
{
"name": "modifier",
"type": "string",
"description": "The full modifier string."
},
{
"name": "merge_tag",
"type": "string",
"description": "The merge tag being processed."
}
],
"categories": [
"views",
"forms"
],
"example": "add_filter( 'gravityview/merge_tags/modifiers/format', function($raw_value, $format, $field, $modifier, $merge_tag) {\n // Modify $raw_value as needed\n return $raw_value;\n}, 10, 5 );",
"since": "2.33",
"source": {
"file": "src/Renderer/MergeTags.php",
"line": 512
},
"url": "/docs/gravityview/filters/gravityview-merge_tags-modifiers-format/",
"related": [
"gravityview/merge_tags/modifiers/value"
]
},
{
"id": "gravityview-merge_tags-modifiers-value",
"name": "gravityview/merge_tags/modifiers/value",
"type": "filter",
"product": "gravityview",
"description": "Modify the merge tag modifier output.",
"parameters": [
{
"name": "return",
"type": "string",
"description": "The current merge tag value to be filtered."
},
{
"name": "raw_value",
"type": "string",
"description": "The raw value submitted for this field. May be CSV or JSON-encoded."
},
{
"name": "value",
"type": "string",
"description": "The original merge tag value, passed from Gravity Forms."
},
{
"name": "merge_tag",
"type": "string",
"description": "If the merge tag being executed is an individual field merge tag (i.e. \\{Name:3\\}), this variable will contain the field's ID. If not, this variable will contain the name of the merge tag (i.e. all_fields)."
},
{
"name": "modifier",
"type": "string",
"description": "The string containing any modifiers for this merge tag. For example, \"maxwords:10\" would be the modifiers for the following merge tag: \\{Text:2:maxwords:10\\}."
},
{
"name": "field",
"type": "[\\GF_Field](https://docs.gravityforms.com/gf_field/)",
"description": "The current field."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/merge_tags/modifiers/value', function($return, $raw_value, $value, $merge_tag, $modifier, $field) {\n // Modify $return as needed\n return $return;\n}, 10, 6 );",
"since": "2.0",
"source": {
"file": "src/Renderer/MergeTags.php",
"line": 352
},
"url": "/docs/gravityview/filters/gravityview-merge_tags-modifiers-value/",
"related": [
"gravityview/merge_tags/modifiers/format"
]
},
{
"id": "gravityview-metaboxes-default",
"name": "gravityview/metaboxes/default",
"type": "filter",
"product": "gravityview",
"description": "Modify the default settings metabox tabs.",
"parameters": [
{
"name": "metaboxes",
"type": "array",
"description": "Array of metabox tab configurations."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/metaboxes/default', function($metaboxes) {\n // Modify $metaboxes as needed\n return $metaboxes;\n}, 10, 1 );",
"since": "1.8",
"source": {
"file": "src/Admin/Metaboxes/AdminMetaboxes.php",
"line": 228
},
"url": "/docs/gravityview/filters/gravityview-metaboxes-default/",
"related": [
"gravityview/metaboxes/after_render",
"gravityview/metaboxes/before_render",
"gravityview/metaboxes/delete_entry",
"gravityview/metaboxes/edit_entry",
"gravityview/metaboxes/permissions_after"
]
},
{
"id": "gravityview-metaboxes-tooltips",
"name": "gravityview/metaboxes/tooltips",
"type": "filter",
"product": "gravityview",
"description": "The tooltips GravityView adds to the Gravity Forms tooltip array.",
"parameters": [
{
"name": "gv_tooltips",
"type": "array",
"description": "Associative array with unique keys containing array of title and value keys, as expected by gform_tooltips filter."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/metaboxes/tooltips', function($gv_tooltips) {\n // Modify $gv_tooltips as needed\n return $gv_tooltips;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 614
},
"url": "/docs/gravityview/filters/gravityview-metaboxes-tooltips/",
"related": [
"gravityview/metaboxes/after_render",
"gravityview/metaboxes/before_render",
"gravityview/metaboxes/delete_entry",
"gravityview/metaboxes/edit_entry",
"gravityview/metaboxes/permissions_after"
]
},
{
"id": "gravityview-option-output-option_type",
"name": "gravityview/option/output/\\{$option_type\\}",
"type": "filter",
"product": "gravityview",
"description": "Modify the output for a GravityView setting.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "field class name"
},
{
"name": "option",
"type": "array",
"description": "option field data"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/option/output/\\{$option_type\\}', function($output, $option) {\n // Modify $output as needed\n return $output;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/Admin/Rendering/RenderSettings.php",
"line": 796
},
"url": "/docs/gravityview/filters/gravityview-option-output-option_type/",
"related": []
},
{
"id": "gravityview-output-.file_type.-filename",
"name": "gravityview/output/ . $file_type . /filename",
"type": "filter",
"product": "gravityview",
"description": "Modify the name of the generated CSV or TSV file. Name will be sanitized using sanitize_file_name() before output.",
"parameters": [
{
"name": "filename",
"type": "string",
"description": "File name used when downloading a CSV or TSV. Default is \"\\{View title\\}.csv\" or \"\\{View title\\}.tsv\""
},
{
"name": "view",
"type": "\\GV\\View",
"description": "Current View being rendered"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/output/ . $file_type . /filename', function($filename, $view) {\n // Modify $filename as needed\n return $filename;\n}, 10, 2 );",
"since": "2.1",
"source": {
"file": "src/View/View.php",
"line": 2713
},
"url": "/docs/gravityview/filters/gravityview-output-.file_type.-filename/",
"related": []
},
{
"id": "gravityview-output-.format.-filename",
"name": "gravityview/output/ . $format . /filename",
"type": "filter",
"product": "gravityview",
"description": "Filter the filename for the CSV or TSV export.",
"parameters": [
{
"name": "filename",
"type": "string",
"description": "The filename. Default: the View title."
},
{
"name": "view",
"type": "\\View",
"description": "The View being exported."
}
],
"categories": [
"views",
"forms"
],
"example": "add_filter( 'gravityview/output/ . $format . /filename', function($filename, $view) {\n // Modify $filename as needed\n return $filename;\n}, 10, 2 );",
"since": "2.21",
"source": {
"file": "src/REST/ViewsRoute.php",
"line": 361
},
"url": "/docs/gravityview/filters/gravityview-output-.format.-filename/",
"related": []
},
{
"id": "gravityview-phpenkoder-msg",
"name": "gravityview/phpenkoder/msg",
"type": "filter",
"product": "gravityview",
"description": "Modify the message shown when Javascript is disabled and an encrypted email field is displayed.",
"parameters": [
{
"name": "message",
"type": "string",
"description": "Existing message."
},
{
"name": "content",
"type": "string",
"description": "Content to encrypt."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/phpenkoder/msg', function($message, $content) {\n // Modify $message as needed\n return $message;\n}, 10, 2 );",
"since": "1.7",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 1917
},
"url": "/docs/gravityview/filters/gravityview-phpenkoder-msg/",
"related": []
},
{
"id": "gravityview-plugin-feature-feature",
"name": "gravityview/plugin/feature/\\{$feature\\}",
"type": "filter",
"product": "gravityview",
"description": "Overrides whether GravityView supports a feature.",
"parameters": [
{
"name": "supports",
"type": "bool\\",
"description": "null`"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/plugin/feature/\\{$feature\\}', function($supports) {\n // Modify $supports as needed\n return $supports;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Core/Plugin.php",
"line": 538
},
"url": "/docs/gravityview/filters/gravityview-plugin-feature-feature/",
"related": []
},
{
"id": "gravityview-post_type-with_front",
"name": "gravityview/post_type/with_front",
"type": "filter",
"product": "gravityview",
"description": "Should the permalink structure be prepended with the front base.",
"parameters": [
{
"name": "with_front",
"type": "bool",
"description": "Whether to prepend the front base. Default: true."
}
],
"categories": [
"views",
"after"
],
"example": "add_filter( 'gravityview/post_type/with_front', function($with_front) {\n // Modify $with_front as needed\n return $with_front;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/View/View.php",
"line": 369
},
"url": "/docs/gravityview/filters/gravityview-post_type-with_front/",
"related": []
},
{
"id": "gravityview-powered_by-text",
"name": "gravityview/powered_by/text",
"type": "filter",
"product": "gravityview",
"description": "Modify the anchor text for the Powered By link.",
"parameters": [
{
"name": "anchor_text",
"type": "string",
"description": "Anchor text for the Powered By link. Default: \"Powered by GravityView\". Will be sanitized before display."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/powered_by/text', function($anchor_text) {\n // Modify $anchor_text as needed\n return $anchor_text;\n}, 10, 1 );",
"since": "2.10",
"source": {
"file": "src/Frontend/PoweredBy.php",
"line": 72
},
"url": "/docs/gravityview/filters/gravityview-powered_by-text/",
"related": [
"gravityview/powered_by/url"
]
},
{
"id": "gravityview-powered_by-url",
"name": "gravityview/powered_by/url",
"type": "filter",
"product": "gravityview",
"description": "Modify the URL returned by the Powered By link.",
"parameters": [
{
"name": "url",
"type": "string",
"description": "The URL passed to the Powered By link."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/powered_by/url', function($url) {\n // Modify $url as needed\n return $url;\n}, 10, 1 );",
"since": "2.10",
"source": {
"file": "src/Frontend/PoweredBy.php",
"line": 107
},
"url": "/docs/gravityview/filters/gravityview-powered_by-url/",
"related": [
"gravityview/powered_by/text"
]
},
{
"id": "gravityview-query-class",
"name": "gravityview/query/class",
"type": "filter",
"product": "gravityview",
"description": "Filters the value.",
"parameters": [
{
"name": "",
"type": "string",
"description": "The query class. Default: GF_Query."
},
{
"name": "this",
"type": "\\GV\\View",
"description": "The View."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/query/class', function($, $this) {\n // Modify $value as needed\n return $value;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/View/View.php",
"line": 2817
},
"url": "/docs/gravityview/filters/gravityview-query-class/",
"related": []
},
{
"id": "gravityview-render-container-class",
"name": "gravityview/render/container/class",
"type": "filter",
"product": "gravityview",
"description": "Modify the CSS class to be added to the wrapper div of a View.",
"parameters": [
{
"name": "css_class",
"type": "string",
"description": "Default: gv-container gv-container-\\{view id\\}. If View is hidden until search, adds hidden. If the View has no results, adds gv-container-no-results"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/render/container/class', function($css_class, $context) {\n // Modify $css_class as needed\n return $css_class;\n}, 10, 2 );",
"since": "1.5.4",
"source": {
"file": "src/API/class-api.php",
"line": 238
},
"url": "/docs/gravityview/filters/gravityview-render-container-class/",
"related": []
},
{
"id": "gravityview-render-hide-empty-zone",
"name": "gravityview/render/hide-empty-zone",
"type": "filter",
"product": "gravityview",
"description": "If a zone has no field output, choose whether to show wrapper.",
"parameters": [
{
"name": "hide_empty_zone",
"type": "bool",
"description": "Default: false."
},
{
"name": "context",
"type": "\\GV\\Template_Context|null",
"description": "The context. Null here since this path is deprecated."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/render/hide-empty-zone', function($hide_empty_zone, $context) {\n // Modify $hide_empty_zone as needed\n return $hide_empty_zone;\n}, 10, 2 );",
"since": "1.7.6",
"source": {
"file": "src/View/ViewLegacy.php",
"line": 754
},
"url": "/docs/gravityview/filters/gravityview-render-hide-empty-zone/",
"related": []
},
{
"id": "gravityview-request-is_renderable",
"name": "gravityview/request/is_renderable",
"type": "filter",
"product": "gravityview",
"description": "Is this request renderable?",
"parameters": [
{
"name": "is_renderable",
"type": "bool",
"description": "Whether the request is renderable."
},
{
"name": "request",
"type": "\\GV\\Request",
"description": "The Request object."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/request/is_renderable', function($is_renderable, $request) {\n // Modify $is_renderable as needed\n return $is_renderable;\n}, 10, 2 );",
"since": "2.5.2",
"source": {
"file": "src/Request/Request.php",
"line": 72
},
"url": "/docs/gravityview/filters/gravityview-request-is_renderable/",
"related": []
},
{
"id": "gravityview-rest-entries-html-insert_meta",
"name": "gravityview/rest/entries/html/insert_meta",
"type": "filter",
"product": "gravityview",
"description": "Filter whether to insert meta tags in the HTML output describing the data.",
"parameters": [
{
"name": "insert_meta",
"type": "bool",
"description": "Whether to add <meta /> tags. Default: true."
},
{
"name": "count",
"type": "int",
"description": "The number of entries being rendered."
},
{
"name": "view",
"type": "\\View",
"description": "The View."
},
{
"name": "request",
"type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)",
"description": "Request object."
},
{
"name": "total",
"type": "int",
"description": "The total number of entries for the request."
}
],
"categories": [
"entries",
"views",
"api"
],
"example": "add_filter( 'gravityview/rest/entries/html/insert_meta', function($insert_meta, $count, $view, $request, $total) {\n // Modify $insert_meta as needed\n return $insert_meta;\n}, 10, 5 );",
"since": "2.0",
"source": {
"file": "src/REST/ViewsRoute.php",
"line": 330
},
"url": "/docs/gravityview/filters/gravityview-rest-entries-html-insert_meta/",
"related": []
},
{
"id": "gravityview-rest-entry-fields",
"name": "gravityview/rest/entry/fields",
"type": "filter",
"product": "gravityview",
"description": "Filter the field IDs that are output in REST requests.",
"parameters": [
{
"name": "allowed_field_ids",
"type": "array",
"description": "Array of field IDs to output. Default: visible fields in the View context."
},
{
"name": "view",
"type": "\\View",
"description": "The View."
},
{
"name": "entry",
"type": "\\GravityKit\\GravityView\\Entry\\Entry",
"description": "The entry."
},
{
"name": "request",
"type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)",
"description": "Request object."
},
{
"name": "context",
"type": "string",
"description": "The context (directory, single)."
}
],
"categories": [
"entries",
"fields",
"views",
"api"
],
"example": "add_filter( 'gravityview/rest/entry/fields', function($allowed_field_ids, $view, $entry, $request, $context) {\n // Modify $allowed_field_ids as needed\n return $allowed_field_ids;\n}, 10, 5 );",
"since": "2.0",
"source": {
"file": "src/REST/ViewsRoute.php",
"line": 163
},
"url": "/docs/gravityview/filters/gravityview-rest-entry-fields/",
"related": []
},
{
"id": "gravityview-rewrite-reserved_slugs",
"name": "gravityview/rewrite/reserved_slugs",
"type": "filter",
"product": "gravityview",
"description": "Modify the reserved embed slugs that trigger a warning.",
"parameters": [
{
"name": "reserved_slugs",
"type": "array",
"description": "An array of strings, reserved slugs."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/rewrite/reserved_slugs', function($reserved_slugs, $gravityview) {\n // Modify $reserved_slugs as needed\n return $reserved_slugs;\n}, 10, 2 );",
"since": "2.5",
"source": {
"file": "src/Renderer/Renderer.php",
"line": 444
},
"url": "/docs/gravityview/filters/gravityview-rewrite-reserved_slugs/",
"related": []
},
{
"id": "gravityview-search-all-split-words",
"name": "gravityview/search-all-split-words",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search-all-split-words', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/Fields/SearchFieldAll.php",
"line": 204
},
"url": "/docs/gravityview/filters/gravityview-search-all-split-words/",
"related": [
"gravityview/loaded",
"gravityview/comments_open",
"gravityview/is_single_entry",
"gravityview/logger",
"gravityview/search-trim-input"
]
},
{
"id": "gravityview-search-chained_selects-alignment",
"name": "gravityview/search/chained_selects/alignment",
"type": "filter",
"product": "gravityview",
"description": "Modifies the alignment of the Chained Select Search Bar input fields.",
"parameters": [
{
"name": "search_layout",
"type": "string",
"description": "The search layout. Default: 'horizontal' or 'vertical'."
},
{
"name": "search_field",
"type": "array",
"description": "The search field configuration array."
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/chained_selects/alignment', function($search_layout, $search_field) {\n // Modify $search_layout as needed\n return $search_layout;\n}, 10, 2 );",
"since": "2.14.4",
"source": {
"file": "src/Widget/Search/templates/search-field-chainedselect.php",
"line": 60
},
"url": "/docs/gravityview/filters/gravityview-search-chained_selects-alignment/",
"related": [
"gravityview/search/chained_selects/hide_inactive",
"gravityview/search/chained_selects/print_styles"
]
},
{
"id": "gravityview-search-chained_selects-hide_inactive",
"name": "gravityview/search/chained_selects/hide_inactive",
"type": "filter",
"product": "gravityview",
"description": "Chooses whether to hide inactive dropdowns in the chain.",
"parameters": [
{
"name": "hide_inactive",
"type": "bool",
"description": "Whether to hide drop-downs that aren't available yet. Default: false."
},
{
"name": "search_field",
"type": "array",
"description": "The search field configuration array."
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/chained_selects/hide_inactive', function($hide_inactive, $search_field) {\n // Modify $hide_inactive as needed\n return $hide_inactive;\n}, 10, 2 );",
"since": "2.14.4",
"source": {
"file": "src/Widget/Search/templates/search-field-chainedselect.php",
"line": 70
},
"url": "/docs/gravityview/filters/gravityview-search-chained_selects-hide_inactive/",
"related": [
"gravityview/search/chained_selects/alignment",
"gravityview/search/chained_selects/print_styles"
]
},
{
"id": "gravityview-search-chained_selects-print_styles",
"name": "gravityview/search/chained_selects/print_styles",
"type": "filter",
"product": "gravityview",
"description": "Prevent Chained Select Search Bar input fields from outputting styles.",
"parameters": [
{
"name": "should_print_styles",
"type": "bool",
"description": "True: Output styles; False: don't."
},
{
"name": "this",
"type": "\\GravityView_Widget_Search",
"description": "GravityView Widget instance."
}
],
"categories": [
"search",
"views",
"assets"
],
"example": "add_filter( 'gravityview/search/chained_selects/print_styles', function($should_print_styles, $this) {\n // Modify $should_print_styles as needed\n return $should_print_styles;\n}, 10, 2 );",
"since": "2.14.4",
"source": {
"file": "src/Integration/GravityFormsChainedSelects.php",
"line": 116
},
"url": "/docs/gravityview/filters/gravityview-search-chained_selects-print_styles/",
"related": [
"gravityview/search/chained_selects/alignment",
"gravityview/search/chained_selects/hide_inactive"
]
},
{
"id": "gravityview-search-created_by-text",
"name": "gravityview/search/created_by/text",
"type": "filter",
"product": "gravityview",
"description": "Filter the display text in created by search choices.",
"parameters": [
{
"name": "",
"type": "string",
"description": "The text. Default: $user->display_name"
},
{
"name": "user",
"type": "[\\WP_User](https://developer.wordpress.org/reference/classes/wp_user/)",
"description": "The user."
},
{
"name": "view",
"type": "\\GV\\View|null",
"description": "The view."
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/created_by/text', function($, $user, $view) {\n // Modify $value as needed\n return $value;\n}, 10, 3 );",
"since": "2.3",
"source": {
"file": "src/Search/Fields/SearchFieldCreatedBy.php",
"line": 106
},
"url": "/docs/gravityview/filters/gravityview-search-created_by-text/",
"related": []
},
{
"id": "gravityview-search-filter_details",
"name": "gravityview/search/filter_details",
"type": "filter",
"product": "gravityview",
"description": "Filter the output filter details for the Search widget.",
"parameters": [
{
"name": "filter",
"type": "array",
"description": "The filter details"
},
{
"name": "field",
"type": "array",
"description": "The search field configuration"
},
{
"name": "",
"type": "\\GV\\Context|null",
"description": "The context"
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/filter_details', function($filter, $field, $) {\n // Modify $filter as needed\n return $filter;\n}, 10, 3 );",
"since": "2.5",
"source": {
"file": "src/Search/Fields/SearchField.php",
"line": 1141
},
"url": "/docs/gravityview/filters/gravityview-search-filter_details/",
"related": [
"gravityview/search/ignore-empty-values",
"gravityview/search/input_labels",
"gravityview/search/input_types",
"gravityview/search/method",
"gravityview/search/mode"
]
},
{
"id": "gravityview-search-ignore-empty-values",
"name": "gravityview/search/ignore-empty-values",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/ignore-empty-values', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/SearchPolicy.php",
"line": 385
},
"url": "/docs/gravityview/filters/gravityview-search-ignore-empty-values/",
"related": [
"gravityview/search/filter_details",
"gravityview/search/input_labels",
"gravityview/search/input_types",
"gravityview/search/method",
"gravityview/search/mode"
]
},
{
"id": "gravityview-search-input_labels",
"name": "gravityview/search/input_labels",
"type": "filter",
"product": "gravityview",
"description": "Change the label of search field input types.",
"parameters": [
{
"name": "input_types",
"type": "array",
"description": "Associative array: key is input type name, value is label"
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/input_labels', function($input_types) {\n // Modify $input_types as needed\n return $input_types;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/Widget/Types/SearchWidget.php",
"line": 307
},
"url": "/docs/gravityview/filters/gravityview-search-input_labels/",
"related": [
"gravityview/search/filter_details",
"gravityview/search/ignore-empty-values",
"gravityview/search/input_types",
"gravityview/search/method",
"gravityview/search/mode"
]
},
{
"id": "gravityview-search-input_types",
"name": "gravityview/search/input_types",
"type": "filter",
"product": "gravityview",
"description": "Change the types of search fields available to a field type.",
"parameters": [
{
"name": "input_types",
"type": "array",
"description": "Associative array: key is field name, value is array of GravityView input types (note: use input_text for text)"
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/input_types', function($input_types) {\n // Modify $input_types as needed\n return $input_types;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/Widget/Types/SearchWidget.php",
"line": 252
},
"url": "/docs/gravityview/filters/gravityview-search-input_types/",
"related": [
"gravityview/search/filter_details",
"gravityview/search/ignore-empty-values",
"gravityview/search/input_labels",
"gravityview/search/method",
"gravityview/search/mode"
]
},
{
"id": "gravityview-search-method",
"name": "gravityview/search/method",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/method', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/Querying/SearchRequest.php",
"line": 516
},
"url": "/docs/gravityview/filters/gravityview-search-method/",
"related": [
"gravityview/search/filter_details",
"gravityview/search/ignore-empty-values",
"gravityview/search/input_labels",
"gravityview/search/input_types",
"gravityview/search/mode"
]
},
{
"id": "gravityview-search-mode",
"name": "gravityview/search/mode",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/mode', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/Querying/Visitors/SearchCriteriaVisitor.php",
"line": 57
},
"url": "/docs/gravityview/filters/gravityview-search-mode/",
"related": [
"gravityview/search/filter_details",
"gravityview/search/ignore-empty-values",
"gravityview/search/input_labels",
"gravityview/search/input_types",
"gravityview/search/method"
]
},
{
"id": "gravityview-search-operator_allowlist",
"name": "gravityview/search/operator_allowlist",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/operator_allowlist', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/SearchPolicy.php",
"line": 116
},
"url": "/docs/gravityview/filters/gravityview-search-operator_allowlist/",
"related": [
"gravityview/search/filter_details",
"gravityview/search/ignore-empty-values",
"gravityview/search/input_labels",
"gravityview/search/input_types",
"gravityview/search/method"
]
},
{
"id": "gravityview-search-operator_whitelist",
"name": "gravityview/search/operator_whitelist",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search/operator_whitelist', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/SearchPolicy.php",
"line": 106
},
"url": "/docs/gravityview/filters/gravityview-search-operator_whitelist/",
"related": [
"gravityview/search/filter_details",
"gravityview/search/ignore-empty-values",
"gravityview/search/input_labels",
"gravityview/search/input_types",
"gravityview/search/method"
]
},
{
"id": "gravityview-search-searchable_fields-allowlist",
"name": "gravityview/search/searchable_fields/allowlist",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"fields",
"search",
"views"
],
"example": "add_filter( 'gravityview/search/searchable_fields/allowlist', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/Policies/SearchFieldsPolicy.php",
"line": 174
},
"url": "/docs/gravityview/filters/gravityview-search-searchable_fields-allowlist/",
"related": [
"gravityview/search/searchable_fields/whitelist"
]
},
{
"id": "gravityview-search-searchable_fields-whitelist",
"name": "gravityview/search/searchable_fields/whitelist",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"fields",
"search",
"views"
],
"example": "add_filter( 'gravityview/search/searchable_fields/whitelist', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/Policies/SearchFieldsPolicy.php",
"line": 164
},
"url": "/docs/gravityview/filters/gravityview-search-searchable_fields-whitelist/",
"related": [
"gravityview/search/searchable_fields/allowlist"
]
},
{
"id": "gravityview-search-searchable_fields",
"name": "gravityview/search/searchable_fields",
"type": "filter",
"product": "gravityview",
"description": "Modify the fields that are displayed as searchable in the Search Bar dropdown.",
"parameters": [
{
"name": "fields",
"type": "array",
"description": "Array of searchable fields, as fetched by gravityview_get_form_fields()"
},
{
"name": "form_id",
"type": "int",
"description": "The form ID."
}
],
"categories": [
"fields",
"search",
"views"
],
"example": "add_filter( 'gravityview/search/searchable_fields', function($fields, $form_id) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "1.17",
"source": {
"file": "src/Widget/Types/SearchWidget.php",
"line": 1465
},
"url": "/docs/gravityview/filters/gravityview-search-searchable_fields/",
"related": [
"gravityview/search/filter_details",
"gravityview/search/ignore-empty-values",
"gravityview/search/input_labels",
"gravityview/search/input_types",
"gravityview/search/method"
]
},
{
"id": "gravityview-search-trim-input",
"name": "gravityview/search-trim-input",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/search-trim-input', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/SearchPolicy.php",
"line": 346
},
"url": "/docs/gravityview/filters/gravityview-search-trim-input/",
"related": [
"gravityview/loaded",
"gravityview/comments_open",
"gravityview/is_single_entry",
"gravityview/logger",
"gravityview/search-all-split-words"
]
},
{
"id": "gravityview-security-require_unfiltered_html",
"name": "gravityview/security/require_unfiltered_html",
"type": "filter",
"product": "gravityview",
"description": "Bypass restrictions on Views that require `unfiltered_html`.",
"parameters": [
{
"name": "require_unfiltered_html",
"type": "bool",
"description": "Whether to require unfiltered_html capability. Default: true."
},
{
"name": "cap",
"type": "string",
"description": "The capability requested."
},
{
"name": "user_id",
"type": "int",
"description": "The user ID."
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview/security/require_unfiltered_html', function($require_unfiltered_html, $cap, $user_id) {\n // Modify $require_unfiltered_html as needed\n return $require_unfiltered_html;\n}, 10, 3 );",
"since": "2.16",
"source": {
"file": "src/View/View.php",
"line": 2845
},
"url": "/docs/gravityview/filters/gravityview-security-require_unfiltered_html/",
"related": []
},
{
"id": "gravityview-setting-class-field_type",
"name": "gravityview/setting/class/\\{$field_type\\}",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/setting/class/\\{$field_type\\}', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Admin/Rendering/RenderSettings.php",
"line": 939
},
"url": "/docs/gravityview/filters/gravityview-setting-class-field_type/",
"related": []
},
{
"id": "gravityview-settings-defaults",
"name": "gravityview/settings/defaults",
"type": "filter",
"product": "gravityview",
"description": "Filter default global settings.",
"parameters": [
{
"name": "defaults",
"type": "array",
"description": "The default settings."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/settings/defaults', function($defaults) {\n // Modify $defaults as needed\n return $defaults;\n}, 10, 1 );",
"since": "2.16",
"source": {
"file": "src/Settings/PluginSettings.php",
"line": 268
},
"url": "/docs/gravityview/filters/gravityview-settings-defaults/",
"related": []
},
{
"id": "gravityview-shortcode-detail-.detail",
"name": "gravityview/shortcode/detail/ . $detail",
"type": "filter",
"product": "gravityview",
"description": "Filter the detail output returned from `[gravityview detail=\"$detail\"]`.",
"parameters": [
{
"name": "return",
"type": "string",
"description": "Existing output."
}
],
"categories": [
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/shortcode/detail/ . $detail', function($return) {\n // Modify $return as needed\n return $return;\n}, 10, 1 );",
"since": "1.13",
"source": {
"file": "src/Shortcode/LegacyShortcode.php",
"line": 199
},
"url": "/docs/gravityview/filters/gravityview-shortcode-detail-.detail/",
"related": [
"gravityview/shortcode/detail/\\{$key\\}"
]
},
{
"id": "gravityview-shortcode-detail-key",
"name": "gravityview/shortcode/detail/\\{$key\\}",
"type": "filter",
"product": "gravityview",
"description": "Filter the detail output returned from `[gravityview detail=\"$detail\"]`.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "Existing output."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View object."
}
],
"categories": [
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/shortcode/detail/\\{$key\\}', function($output, $view) {\n // Modify $output as needed\n return $output;\n}, 10, 2 );",
"since": "1.13",
"source": {
"file": "src/Shortcode/GravityViewShortcode.php",
"line": 520
},
"url": "/docs/gravityview/filters/gravityview-shortcode-detail-key/",
"related": [
"gravityview/shortcode/detail/ . $detail"
]
},
{
"id": "gravityview-shortcodes-gventry-atts",
"name": "gravityview/shortcodes/gventry/atts",
"type": "filter",
"product": "gravityview",
"description": "Filter the [gventry] shortcode attributes.",
"parameters": [
{
"name": "atts",
"type": "array",
"description": "The initial attributes."
}
],
"categories": [
"entries",
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/shortcodes/gventry/atts', function($atts) {\n // Modify $atts as needed\n return $atts;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Shortcode/GVEntryShortcode.php",
"line": 73
},
"url": "/docs/gravityview/filters/gravityview-shortcodes-gventry-atts/",
"related": [
"gravityview/shortcodes/gventry/output"
]
},
{
"id": "gravityview-shortcodes-gventry-edit-success",
"name": "gravityview/shortcodes/gventry/edit/success",
"type": "filter",
"product": "gravityview",
"description": "Modify the edit entry success message in [gventry].",
"parameters": [
{
"name": "message",
"type": "string",
"description": "The message."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View."
},
{
"name": "entry",
"type": "\\Entry",
"description": "The entry."
},
{
"name": "atts",
"type": "array",
"description": "The attributes."
},
{
"name": "back_link",
"type": "string",
"description": "URL to return to the original entry."
},
{
"name": "redirect_url",
"type": "string\\",
"description": "null`"
}
],
"categories": [
"entries",
"editing",
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/shortcodes/gventry/edit/success', function($message, $view, $entry, $atts, $back_link, $redirect_url) {\n // Modify $message as needed\n return $message;\n}, 10, 6 );",
"since": "2.10",
"source": {
"file": "src/Shortcode/GVEntryShortcode.php",
"line": 188
},
"url": "/docs/gravityview/filters/gravityview-shortcodes-gventry-edit-success/",
"related": []
},
{
"id": "gravityview-shortcodes-gventry-output",
"name": "gravityview/shortcodes/gventry/output",
"type": "filter",
"product": "gravityview",
"description": "Filter the [gventry] output.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "The output."
},
{
"name": "view",
"type": "\\GV\\View|null",
"description": "The View detected or null."
},
{
"name": "entry",
"type": "\\Entry\\",
"description": "null`"
},
{
"name": "atts",
"type": "array",
"description": "The shortcode attributes."
}
],
"categories": [
"entries",
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/shortcodes/gventry/output', function($output, $view, $entry, $atts) {\n // Modify $output as needed\n return $output;\n}, 10, 4 );",
"since": "2.0",
"source": {
"file": "src/Shortcode/GVEntryShortcode.php",
"line": 226
},
"url": "/docs/gravityview/filters/gravityview-shortcodes-gventry-output/",
"related": [
"gravityview/shortcodes/gventry/atts"
]
},
{
"id": "gravityview-shortcodes-gvfield-atts",
"name": "gravityview/shortcodes/gvfield/atts",
"type": "filter",
"product": "gravityview",
"description": "Filter the [gvfield] shortcode attributes.",
"parameters": [
{
"name": "atts",
"type": "array",
"description": "The initial attributes."
}
],
"categories": [
"fields",
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/shortcodes/gvfield/atts', function($atts) {\n // Modify $atts as needed\n return $atts;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Shortcode/GVFieldShortcode.php",
"line": 66
},
"url": "/docs/gravityview/filters/gravityview-shortcodes-gvfield-atts/",
"related": [
"gravityview/shortcodes/gvfield/output"
]
},
{
"id": "gravityview-shortcodes-gvfield-output",
"name": "gravityview/shortcodes/gvfield/output",
"type": "filter",
"product": "gravityview",
"description": "Filter the [gvfield] output.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "The output."
},
{
"name": "view",
"type": "\\GV\\View|null",
"description": "The View detected or null."
},
{
"name": "entry",
"type": "\\Entry\\",
"description": "null`"
},
{
"name": "field",
"type": "\\GV\\Field|null",
"description": "The Field or null."
},
{
"name": "atts",
"type": "array",
"description": "The shortcode attributes."
}
],
"categories": [
"fields",
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/shortcodes/gvfield/output', function($output, $view, $entry, $field, $atts) {\n // Modify $output as needed\n return $output;\n}, 10, 5 );",
"since": "2.0",
"source": {
"file": "src/Shortcode/GVFieldShortcode.php",
"line": 157
},
"url": "/docs/gravityview/filters/gravityview-shortcodes-gvfield-output/",
"related": [
"gravityview/shortcodes/gvfield/atts"
]
},
{
"id": "gravityview-shortcodes-gvlogic-output",
"name": "gravityview/shortcodes/gvlogic/output",
"type": "filter",
"product": "gravityview",
"description": "Filters the final output of the [gvlogic] shortcode.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "The shortcode output."
},
{
"name": "atts",
"type": "array",
"description": "The shortcode attributes."
}
],
"categories": [
"views",
"shortcodes"
],
"example": "add_filter( 'gravityview/shortcodes/gvlogic/output', function($output, $atts) {\n // Modify $output as needed\n return $output;\n}, 10, 2 );",
"since": "2.5",
"source": {
"file": "src/Shortcode/GVLogicShortcode.php",
"line": 135
},
"url": "/docs/gravityview/filters/gravityview-shortcodes-gvlogic-output/",
"related": []
},
{
"id": "gravityview-show-settings-menu",
"name": "gravityview/show-settings-menu",
"type": "filter",
"product": "gravityview",
"description": "Override whether to show GravityView settings.",
"parameters": [
{
"name": "show_settings",
"type": "bool",
"description": "Whether to show the settings menu. Default: true."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/show-settings-menu', function($show_settings) {\n // Modify $show_settings as needed\n return $show_settings;\n}, 10, 1 );",
"since": "1.7.6",
"source": {
"file": "src/Settings/PluginSettings.php",
"line": 288
},
"url": "/docs/gravityview/filters/gravityview-show-settings-menu/",
"related": [
"gravityview/loaded",
"gravityview/comments_open",
"gravityview/is_single_entry",
"gravityview/logger",
"gravityview/search-all-split-words"
]
},
{
"id": "gravityview-single-title-check_entry_display",
"name": "gravityview/single/title/check_entry_display",
"type": "filter",
"product": "gravityview",
"description": "Override whether to check entry display rules against filters.",
"parameters": [
{
"name": "check_entry_display",
"type": "bool",
"description": "Check whether the entry is visible for the current View configuration. Default: true."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array"
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View"
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/single/title/check_entry_display', function($check_entry_display, $entry, $view) {\n // Modify $check_entry_display as needed\n return $check_entry_display;\n}, 10, 3 );",
"since": "2.7.2",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 752
},
"url": "/docs/gravityview/filters/gravityview-single-title-check_entry_display/",
"related": [
"gravityview/single/title/out_loop"
]
},
{
"id": "gravityview-single-title-out_loop",
"name": "gravityview/single/title/out_loop",
"type": "filter",
"product": "gravityview",
"description": "Apply the Single Entry Title filter outside the WordPress loop?",
"parameters": [
{
"name": "in_the_loop",
"type": "bool",
"description": "Whether to apply the filter to the menu title and the meta tag <title> - outside the loop"
},
{
"name": "entry",
"type": "array",
"description": "Current entry"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/single/title/out_loop', function($in_the_loop, $entry) {\n // Modify $in_the_loop as needed\n return $in_the_loop;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/Frontend/Frontend.php",
"line": 669
},
"url": "/docs/gravityview/filters/gravityview-single-title-out_loop/",
"related": [
"gravityview/single/title/check_entry_display"
]
},
{
"id": "gravityview-sortable-field_blacklist",
"name": "gravityview/sortable/field_blacklist",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/sortable/field_blacklist', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": "1.7",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 2634
},
"url": "/docs/gravityview/filters/gravityview-sortable-field_blacklist/",
"related": [
"gravityview/sortable/field_blocklist"
]
},
{
"id": "gravityview-sortable-field_blocklist",
"name": "gravityview/sortable/field_blocklist",
"type": "filter",
"product": "gravityview",
"description": "Modify what fields should never be sortable.",
"parameters": [
{
"name": "not_sortable",
"type": "array",
"description": "Array of field types that aren't sortable."
},
{
"name": "field_type",
"type": "string",
"description": "Field type to check whether the field is sortable."
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form."
},
{
"name": "field_id",
"type": "string",
"description": "Gravity Forms field ID (might be the same as field_type)."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/sortable/field_blocklist', function($not_sortable, $field_type, $form, $field_id) {\n // Modify $not_sortable as needed\n return $not_sortable;\n}, 10, 4 );",
"since": "2.14",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 2645
},
"url": "/docs/gravityview/filters/gravityview-sortable-field_blocklist/",
"related": [
"gravityview/sortable/field_blacklist"
]
},
{
"id": "gravityview-sorting-address",
"name": "gravityview/sorting/address",
"type": "filter",
"product": "gravityview",
"description": "Override how to sort when sorting address",
"parameters": [
{
"name": "address_part",
"type": "string",
"description": "street, street2, city, state, zip, or country (default: city)"
},
{
"name": "sort_field_id",
"type": "string",
"description": "Field used for sorting"
},
{
"name": "form_id",
"type": "int",
"description": "GF Form ID"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/sorting/address', function($address_part, $sort_field_id, $form_id) {\n // Modify $address_part as needed\n return $address_part;\n}, 10, 3 );",
"since": "1.8",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1685
},
"url": "/docs/gravityview/filters/gravityview-sorting-address/",
"related": [
"gravityview/sorting/full-name",
"gravityview/sorting/time"
]
},
{
"id": "gravityview-sorting-full-name",
"name": "gravityview/sorting/full-name",
"type": "filter",
"product": "gravityview",
"description": "Override how to sort when sorting full name.",
"parameters": [
{
"name": "name_part",
"type": "string",
"description": "Sort by first, last or first-last (default: first-last)"
},
{
"name": "sort_field_id",
"type": "string",
"description": "Field used for sorting"
},
{
"name": "form_id",
"type": "int",
"description": "GF Form ID"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/sorting/full-name', function($name_part, $sort_field_id, $form_id) {\n // Modify $name_part as needed\n return $name_part;\n}, 10, 3 );",
"since": "1.7.4",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1723
},
"url": "/docs/gravityview/filters/gravityview-sorting-full-name/",
"related": [
"gravityview/sorting/address",
"gravityview/sorting/time"
]
},
{
"id": "gravityview-sorting-time",
"name": "gravityview/sorting/time",
"type": "filter",
"product": "gravityview",
"description": "Override how to sort when sorting time.",
"parameters": [
{
"name": "sort_field_id",
"type": "string",
"description": "Field used for sorting."
},
{
"name": "form_id",
"type": "int",
"description": "GF Form ID."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/sorting/time', function($sort_field_id, $form_id) {\n // Modify $sort_field_id as needed\n return $sort_field_id;\n}, 10, 2 );",
"since": "1.14",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1747
},
"url": "/docs/gravityview/filters/gravityview-sorting-time/",
"related": [
"gravityview/sorting/address",
"gravityview/sorting/full-name"
]
},
{
"id": "gravityview-support_port-display",
"name": "gravityview/support_port/display",
"type": "filter",
"product": "gravityview",
"description": "Whether to display Support Port.",
"parameters": [
{
"name": "display_support_port",
"type": "bool",
"description": "Whether to display Support Port. Default: true."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/support_port/display', function($display_support_port) {\n // Modify $display_support_port as needed\n return $display_support_port;\n}, 10, 1 );",
"since": "1.15",
"source": {
"file": "src/Admin/SupportPort.php",
"line": 146
},
"url": "/docs/gravityview/filters/gravityview-support_port-display/",
"related": [
"gravityview/support_port/localization_data",
"gravityview/support_port/show_profile_setting"
]
},
{
"id": "gravityview-support_port-localization_data",
"name": "gravityview/support_port/localization_data",
"type": "filter",
"product": "gravityview",
"description": "Filter data passed to the Support Port, before localize_script is run.",
"parameters": [
{
"name": "suggest",
"type": "array",
"description": "Article IDs to recommend to the user (per page in the admin)."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/support_port/localization_data', function($suggest) {\n // Modify $suggest as needed\n return $suggest;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Admin/SupportPort.php",
"line": 178
},
"url": "/docs/gravityview/filters/gravityview-support_port-localization_data/",
"related": [
"gravityview/support_port/display",
"gravityview/support_port/show_profile_setting"
]
},
{
"id": "gravityview-support_port-show_profile_setting",
"name": "gravityview/support_port/show_profile_setting",
"type": "filter",
"product": "gravityview",
"description": "Should the \"GravityView Support Port\" setting be shown on user profiles?",
"parameters": [
{
"name": "allow_profile_setting",
"type": "bool",
"description": "Whether to show the setting. Default: true, if the user has the gravityview_support_port capability, which defaults to true for Contributors and higher."
},
{
"name": "user",
"type": "[\\WP_User](https://developer.wordpress.org/reference/classes/wp_user/)",
"description": "Current user object."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/support_port/show_profile_setting', function($allow_profile_setting, $user) {\n // Modify $allow_profile_setting as needed\n return $allow_profile_setting;\n}, 10, 2 );",
"since": "1.15",
"source": {
"file": "src/Admin/SupportPort.php",
"line": 274
},
"url": "/docs/gravityview/filters/gravityview-support_port-show_profile_setting/",
"related": [
"gravityview/support_port/display",
"gravityview/support_port/localization_data"
]
},
{
"id": "gravityview-template-csv-field-raw",
"name": "gravityview/template/csv/field/raw",
"type": "filter",
"product": "gravityview",
"description": "Filters field types to output by value instead of display_value.",
"parameters": [
{
"name": "raw",
"type": "bool",
"description": "Raw or not. By default, outputs raw for $raw_types."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The template context."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/csv/field/raw', function($raw, $gravityview) {\n // Modify $raw as needed\n return $raw;\n}, 10, 2 );",
"since": "2.5",
"source": {
"file": "templates/fields/field-csv.php",
"line": 36
},
"url": "/docs/gravityview/filters/gravityview-template-csv-field-raw/",
"related": []
},
{
"id": "gravityview-template-entry-class",
"name": "gravityview/template/entry/class",
"type": "filter",
"product": "gravityview",
"description": "Filter the template class that is about to be used to render the entry.",
"parameters": [
{
"name": "class",
"type": "string",
"description": "The chosen class. Default: \\GV\\Entry_Table_Template."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "The entry about to be rendered."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View connected to it."
},
{
"name": "request",
"type": "\\GV\\Request",
"description": "The associated request."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/entry/class', function($class, $entry, $view, $request) {\n // Modify $class as needed\n return $class;\n}, 10, 4 );",
"since": "2.0",
"source": {
"file": "src/Renderer/EntryRenderer.php",
"line": 133
},
"url": "/docs/gravityview/filters/gravityview-template-entry-class/",
"related": [
"gravityview/template/entry/context"
]
},
{
"id": "gravityview-template-entry-context",
"name": "gravityview/template/entry/context",
"type": "filter",
"product": "gravityview",
"description": "Make various pieces of data available to the template under the $gravityview scoped variable.",
"parameters": [
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context for this template."
},
{
"name": "template",
"type": "\\GV\\Entry_Template",
"description": "The current template."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/entry/context', function($context, $template) {\n // Modify $context as needed\n return $context;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Template/TemplateEntry.php",
"line": 163
},
"url": "/docs/gravityview/filters/gravityview-template-entry-context/",
"related": [
"gravityview/template/entry/class"
]
},
{
"id": "gravityview-template-field-address-csv-delimiter",
"name": "gravityview/template/field/address/csv/delimiter",
"type": "filter",
"product": "gravityview",
"description": "The address parts delimiter.",
"parameters": [
{
"name": "delimiter",
"type": "string",
"description": "The delimiter. Default: newline."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The template context."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/address/csv/delimiter', function($delimiter, $gravityview) {\n // Modify $delimiter as needed\n return $delimiter;\n}, 10, 2 );",
"since": "2.4",
"source": {
"file": "templates/fields/field-address-csv.php",
"line": 59
},
"url": "/docs/gravityview/filters/gravityview-template-field-address-csv-delimiter/",
"related": []
},
{
"id": "gravityview-template-field-class",
"name": "gravityview/template/field/class",
"type": "filter",
"product": "gravityview",
"description": "Filter the template class that is about to be used to render the view.",
"parameters": [
{
"name": "class",
"type": "string",
"description": "The chosen class - Default: \\GV\\Field_HTML_Template."
},
{
"name": "field",
"type": "\\GV\\Field",
"description": "The field about to be rendered."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The view in this context, if applicable."
},
{
"name": "source",
"type": "\\GV\\Source",
"description": "The source (form) in this context, if applicable."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "The entry in this context, if applicable."
},
{
"name": "request",
"type": "\\GV\\Request",
"description": "The request in this context, if applicable."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/class', function($class, $field, $view, $source, $entry, $request) {\n // Modify $class as needed\n return $class;\n}, 10, 6 );",
"since": "2.0",
"source": {
"file": "src/Renderer/FieldRenderer.php",
"line": 69
},
"url": "/docs/gravityview/filters/gravityview-template-field-class/",
"related": [
"gravityview/template/field/context",
"gravityview/template/field/entry_link",
"gravityview/template/field/label",
"gravityview/template/field/output",
"gravityview/template/field/label"
]
},
{
"id": "gravityview-template-field-context",
"name": "gravityview/template/field/context",
"type": "filter",
"product": "gravityview",
"description": "Make various pieces of data available to the template under the $gravityview scoped variable.",
"parameters": [
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context for this template."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/context', function($context) {\n // Modify $context as needed\n return $context;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Template/TemplateField.php",
"line": 331
},
"url": "/docs/gravityview/filters/gravityview-template-field-context/",
"related": [
"gravityview/template/field/class",
"gravityview/template/field/entry_link",
"gravityview/template/field/label",
"gravityview/template/field/output",
"gravityview/template/field/label"
]
},
{
"id": "gravityview-template-field-csv-glue",
"name": "gravityview/template/field/csv/glue",
"type": "filter",
"product": "gravityview",
"description": "The value used to separate multiple values in the CSV export.",
"parameters": [
{
"name": "glue",
"type": "string",
"description": "The glue. Default: \";\" (semicolon)."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The template context."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/csv/glue', function($glue, $gravityview) {\n // Modify $glue as needed\n return $glue;\n}, 10, 2 );",
"since": "2.4.2",
"source": {
"file": "templates/fields/field-business_hours-csv.php",
"line": 33
},
"url": "/docs/gravityview/filters/gravityview-template-field-csv-glue/",
"related": [
"gravityview/template/field/csv/tick"
]
},
{
"id": "gravityview-template-field-csv-tick",
"name": "gravityview/template/field/csv/tick",
"type": "filter",
"product": "gravityview",
"description": "Change the output for a checkbox \"check\" symbol.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "Checkbox \"check\" symbol. Default: \"✓\"."
},
{
"name": "entry",
"type": "array",
"description": "Entry data."
},
{
"name": "field",
"type": "[\\GF_Field_Checkbox](https://docs.gravityforms.com/gf_field_checkbox/)",
"description": "GravityView field."
},
{
"name": "gravityview",
"type": "\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/csv/tick', function($output, $entry, $field, $gravityview) {\n // Modify $output as needed\n return $output;\n}, 10, 4 );",
"since": "2.33",
"source": {
"file": "templates/fields/field-checkbox-csv.php",
"line": 61
},
"url": "/docs/gravityview/filters/gravityview-template-field-csv-tick/",
"related": [
"gravityview/template/field/csv/glue"
]
},
{
"id": "gravityview-template-field-entry_link",
"name": "gravityview/template/field/entry_link",
"type": "filter",
"product": "gravityview",
"description": "Modify the link HTML.",
"parameters": [
{
"name": "link",
"type": "string",
"description": "HTML output of the link"
},
{
"name": "href",
"type": "string",
"description": "URL of the link"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context"
}
],
"categories": [
"entries",
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/entry_link', function($link, $href, $context) {\n // Modify $link as needed\n return $link;\n}, 10, 3 );",
"since": "2.0",
"source": {
"file": "templates/fields/field-edit_link-html.php",
"line": 67
},
"url": "/docs/gravityview/filters/gravityview-template-field-entry_link/",
"related": [
"gravityview/template/field/class",
"gravityview/template/field/context",
"gravityview/template/field/label",
"gravityview/template/field/output",
"gravityview/template/field/label"
]
},
{
"id": "gravityview-template-field-field-type-output",
"name": "gravityview/template/field/\\{$field->type\\}/output",
"type": "filter",
"product": "gravityview",
"description": "Modify the field output for a field type.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "The current output."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The template context this is being called from."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/\\{$field->type\\}/output', function($output, $context) {\n // Modify $output as needed\n return $output;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Template/TemplateField.php",
"line": 492
},
"url": "/docs/gravityview/filters/gravityview-template-field-field-type-output/",
"related": []
},
{
"id": "gravityview-template-field-label",
"name": "gravityview/template/field/label",
"type": "filter",
"product": "gravityview",
"description": "Override the field label.",
"parameters": [
{
"name": "label",
"type": "string",
"description": "The label to override."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/label', function($label, $context) {\n // Modify $label as needed\n return $label;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Renderer/FieldRendererTrait.php",
"line": 60
},
"url": "/docs/gravityview/filters/gravityview-template-field-label/",
"related": [
"gravityview/template/field/class",
"gravityview/template/field/context",
"gravityview/template/field/entry_link",
"gravityview/template/field/output"
]
},
{
"id": "gravityview-template-field-output",
"name": "gravityview/template/field/output",
"type": "filter",
"product": "gravityview",
"description": "Modify the field output for a field.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "The current output."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The template context this is being called from."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/output', function($output, $context) {\n // Modify $output as needed\n return $output;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Template/TemplateField.php",
"line": 522
},
"url": "/docs/gravityview/filters/gravityview-template-field-output/",
"related": [
"gravityview/template/field/class",
"gravityview/template/field/context",
"gravityview/template/field/entry_link",
"gravityview/template/field/label",
"gravityview/template/field/label"
]
},
{
"id": "gravityview-template-field-survey-glue",
"name": "gravityview/template/field/survey/glue",
"type": "filter",
"product": "gravityview",
"description": "The value used to separate multiple values in the Survey field output.",
"parameters": [
{
"name": "glue",
"type": "string",
"description": "The glue. Default: \"; \" (semicolon with a trailing space)."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field/survey/glue', function($glue, $gravityview) {\n // Modify $glue as needed\n return $glue;\n}, 10, 2 );",
"since": "2.10.4",
"source": {
"file": "templates/fields/field-survey-html.php",
"line": 135
},
"url": "/docs/gravityview/filters/gravityview-template-field-survey-glue/",
"related": []
},
{
"id": "gravityview-template-field_label",
"name": "gravityview/template/field_label",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "label",
"type": "string",
"description": "Field label HTML."
},
{
"name": "field_settings",
"type": "array",
"description": "GravityView field array."
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form array."
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field_label', function($label, $field_settings, $form, $entry) {\n // Modify $label as needed\n return $label;\n}, 10, 4 );",
"since": "1.7",
"source": {
"file": "src/GravityForms/QueryExtensions/_mocks.php",
"line": 284
},
"url": "/docs/gravityview/filters/gravityview-template-field_label/",
"related": [
"gravityview/template/after",
"gravityview/template/before",
"gravityview/template/footer",
"gravityview/template/header"
]
},
{
"id": "gravityview-template-field_output-context",
"name": "gravityview/template/field_output/context",
"type": "filter",
"product": "gravityview",
"description": "Modify the context before generation begins.",
"parameters": [
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
},
{
"name": "args",
"type": "array",
"description": "The sanitized arguments, these should not be trusted any longer."
},
{
"name": "passed_args",
"type": "array",
"description": "The passed arguments, these should not be trusted any longer."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/field_output/context', function($context, $args, $passed_args) {\n // Modify $context as needed\n return $context;\n}, 10, 3 );",
"since": "2.0",
"source": {
"file": "src/API/class-api.php",
"line": 988
},
"url": "/docs/gravityview/filters/gravityview-template-field_output-context/",
"related": []
},
{
"id": "gravityview-template-layout-builder-entry-class",
"name": "gravityview/template/layout-builder/entry/class",
"type": "filter",
"product": "gravityview",
"description": "Modify the class applied to the entry row.",
"parameters": [
{
"name": "class",
"type": "string",
"description": "The existing class."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/layout-builder/entry/class', function($class, $context) {\n // Modify $class as needed\n return $class;\n}, 10, 2 );",
"since": "2.46.2",
"source": {
"file": "src/Template/View/LayoutBuilder.php",
"line": 69
},
"url": "/docs/gravityview/filters/gravityview-template-layout-builder-entry-class/",
"related": []
},
{
"id": "gravityview-template-layout-builder-row-attributes",
"name": "gravityview/template/layout-builder/row/attributes",
"type": "filter",
"product": "gravityview",
"description": "Modifies the attributes for a Layout Builder row.",
"parameters": [
{
"name": "attributes",
"type": "array",
"description": "Row HTML attributes."
},
{
"name": "class",
"type": "string",
"description": "The CSS classes for the row."
},
{
"name": "id",
"type": "string",
"description": "The HTML ID for the row."
},
{
"name": "row",
"type": "array",
"description": "The row configuration."
},
{
"name": "row_setting",
"type": "array",
"description": "The row settings (custom_class, custom_id)."
},
{
"name": "entry",
"type": "\\GV\\Entry",
"description": "The current entry."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/layout-builder/row/attributes', function($attributes, $class, $id, $row, $row_setting, $entry) {\n // Modify $attributes as needed\n return $attributes;\n}, 10, 6 );",
"since": "2.54.0",
"source": {
"file": "templates/views/gravityview-layout-builder.php",
"line": 122
},
"url": "/docs/gravityview/filters/gravityview-template-layout-builder-row-attributes/",
"related": []
},
{
"id": "gravityview-template-links-back-atts",
"name": "gravityview/template/links/back/atts",
"type": "filter",
"product": "gravityview",
"description": "Modify the attributes used on the back link anchor tag.",
"parameters": [
{
"name": "atts",
"type": "array",
"description": "Original attributes, default: [ data-viewid => $view_id ]"
},
{
"name": "",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/links/back/atts', function($atts, $) {\n // Modify $atts as needed\n return $atts;\n}, 10, 2 );",
"since": "2.1",
"source": {
"file": "src/API/class-api.php",
"line": 435
},
"url": "/docs/gravityview/filters/gravityview-template-links-back-atts/",
"related": [
"gravityview/template/links/back/label",
"gravityview/template/links/back/url"
]
},
{
"id": "gravityview-template-links-back-label",
"name": "gravityview/template/links/back/label",
"type": "filter",
"product": "gravityview",
"description": "Modify the back link text.",
"parameters": [
{
"name": "label",
"type": "string",
"description": "Existing label text"
},
{
"name": "",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/links/back/label', function($label, $) {\n // Modify $label as needed\n return $label;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/API/class-api.php",
"line": 426
},
"url": "/docs/gravityview/filters/gravityview-template-links-back-label/",
"related": [
"gravityview/template/links/back/atts",
"gravityview/template/links/back/url"
]
},
{
"id": "gravityview-template-links-back-url",
"name": "gravityview/template/links/back/url",
"type": "filter",
"product": "gravityview",
"description": "Modify the back link URL.",
"parameters": [
{
"name": "href",
"type": "string",
"description": "Existing label URL"
},
{
"name": "",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/links/back/url', function($href, $) {\n // Modify $href as needed\n return $href;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/API/class-api.php",
"line": 390
},
"url": "/docs/gravityview/filters/gravityview-template-links-back-url/",
"related": [
"gravityview/template/links/back/atts",
"gravityview/template/links/back/label"
]
},
{
"id": "gravityview-template-list-entry-class",
"name": "gravityview/template/list/entry/class",
"type": "filter",
"product": "gravityview",
"description": "Modify the class applied to the entry row.",
"parameters": [
{
"name": "class",
"type": "string",
"description": "The existing class."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/list/entry/class', function($class, $context) {\n // Modify $class as needed\n return $class;\n}, 10, 2 );",
"since": "2.0.6.1",
"source": {
"file": "src/Template/View/ListTemplate.php",
"line": 167
},
"url": "/docs/gravityview/filters/gravityview-template-list-entry-class/",
"related": []
},
{
"id": "gravityview-template-table-columns-count",
"name": "gravityview/template/table/columns/count",
"type": "filter",
"product": "gravityview",
"description": "Filters the number of table columns used for colspan calculations.",
"parameters": [
{
"name": "column_count",
"type": "int",
"description": "Number of visible table columns."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The template context."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/table/columns/count', function($column_count, $gravityview) {\n // Modify $column_count as needed\n return $column_count;\n}, 10, 2 );",
"since": "3.0.0",
"source": {
"file": "templates/views/table/table-body.php",
"line": 32
},
"url": "/docs/gravityview/filters/gravityview-template-table-columns-count/",
"related": [
"gravityview/template/table/columns/after",
"gravityview/template/table/columns/before"
]
},
{
"id": "gravityview-template-table-entry-class",
"name": "gravityview/template/table/entry/class",
"type": "filter",
"product": "gravityview",
"description": "Modify the class applied to the entry row.",
"parameters": [
{
"name": "class",
"type": "string",
"description": "The existing class."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/table/entry/class', function($class, $context) {\n // Modify $class as needed\n return $class;\n}, 10, 2 );",
"since": "2.0.6.1",
"source": {
"file": "src/Template/View/Table.php",
"line": 655
},
"url": "/docs/gravityview/filters/gravityview-template-table-entry-class/",
"related": [
"gravityview/template/table/entry/markup"
]
},
{
"id": "gravityview-template-table-entry-markup",
"name": "gravityview/template/table/entry/markup",
"type": "filter",
"product": "gravityview",
"description": "Modifies the table row markup for an entry.",
"parameters": [
{
"name": "markup",
"type": "string",
"description": "The markup."
},
{
"name": "field",
"type": "\\GV\\Field",
"description": "The field."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/table/entry/markup', function($markup, $field) {\n // Modify $markup as needed\n return $markup;\n}, 10, 2 );",
"since": "2.29.0",
"source": {
"file": "src/Template/Entry/Table.php",
"line": 151
},
"url": "/docs/gravityview/filters/gravityview-template-table-entry-markup/",
"related": [
"gravityview/template/table/entry/class"
]
},
{
"id": "gravityview-template-table-entry-row-attributes",
"name": "gravityview/template/table/entry/row/attributes",
"type": "filter",
"product": "gravityview",
"description": "Filter the row attributes for the row in table view.",
"parameters": [
{
"name": "attributes",
"type": "array",
"description": "The HTML attributes."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/table/entry/row/attributes', function($attributes, $context) {\n // Modify $attributes as needed\n return $attributes;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Template/View/Table.php",
"line": 370
},
"url": "/docs/gravityview/filters/gravityview-template-table-entry-row-attributes/",
"related": []
},
{
"id": "gravityview-template-table-fields",
"name": "gravityview/template/table/fields",
"type": "filter",
"product": "gravityview",
"description": "Modify the fields displayed in this tables.",
"parameters": [
{
"name": "fields",
"type": "\\GV\\Field_Collection",
"description": "The fields."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/table/fields', function($fields, $context) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Template/View/Table.php",
"line": 358
},
"url": "/docs/gravityview/filters/gravityview-template-table-fields/",
"related": [
"gravityview/template/table/use-legacy-style"
]
},
{
"id": "gravityview-template-table-use-legacy-style",
"name": "gravityview/template/table/use-legacy-style",
"type": "filter",
"product": "gravityview",
"description": "Should GravityView use the legacy Table layout stylesheet (from before Version 2.1)?",
"parameters": [
{
"name": "use_legacy_table_style",
"type": "bool",
"description": "If true, loads table-view-legacy.css. If false, loads table-view.css. Default: false"
}
],
"categories": [
"rendering",
"views",
"assets"
],
"example": "add_filter( 'gravityview/template/table/use-legacy-style', function($use_legacy_table_style) {\n // Modify $use_legacy_table_style as needed\n return $use_legacy_table_style;\n}, 10, 1 );",
"since": "2.1.1",
"source": {
"file": "src/Preset/DefaultTable.php",
"line": 26
},
"url": "/docs/gravityview/filters/gravityview-template-table-use-legacy-style/",
"related": [
"gravityview/template/table/fields"
]
},
{
"id": "gravityview-template-text-no_entries",
"name": "gravityview/template/text/no_entries",
"type": "filter",
"product": "gravityview",
"description": "Modify the text displayed when there are no entries.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "The existing \"No Entries\" text."
},
{
"name": "is_search",
"type": "bool",
"description": "Is the current page a search result, or just a multiple entries screen?"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
},
{
"name": "unformatted_output",
"type": "string",
"description": "Output without wpautop()."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/text/no_entries', function($output, $is_search, $context, $unformatted_output) {\n // Modify $output as needed\n return $output;\n}, 10, 4 );",
"since": "2.0",
"source": {
"file": "src/API/API.php",
"line": 450
},
"url": "/docs/gravityview/filters/gravityview-template-text-no_entries/",
"related": []
},
{
"id": "gravityview-template-view-class",
"name": "gravityview/template/view/class",
"type": "filter",
"product": "gravityview",
"description": "Filter the template class that is about to be used to render the View.",
"parameters": [
{
"name": "class",
"type": "string",
"description": "The chosen class. Default: \\GV\\View_Table_Template."
},
{
"name": "view",
"type": "\\View",
"description": "The View about to be rendered."
},
{
"name": "request",
"type": "\\GV\\Request",
"description": "The associated request."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/view/class', function($class, $view, $request) {\n // Modify $class as needed\n return $class;\n}, 10, 3 );",
"since": "2.0",
"source": {
"file": "src/Renderer/ViewRenderer.php",
"line": 113
},
"url": "/docs/gravityview/filters/gravityview-template-view-class/",
"related": [
"gravityview/template/view/render",
"gravityview/template/view/context"
]
},
{
"id": "gravityview-template-view-context",
"name": "gravityview/template/view/context",
"type": "filter",
"product": "gravityview",
"description": "Make various pieces of data available to the template under the $gravityview scoped variable.",
"parameters": [
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context for this template."
},
{
"name": "template",
"type": "\\GV\\View_Template",
"description": "The current template."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/template/view/context', function($context, $template) {\n // Modify $context as needed\n return $context;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Template/TemplateView.php",
"line": 143
},
"url": "/docs/gravityview/filters/gravityview-template-view-context/",
"related": [
"gravityview/template/view/render",
"gravityview/template/view/class"
]
},
{
"id": "gravityview-tooltips-tooltip",
"name": "gravityview/tooltips/tooltip",
"type": "filter",
"product": "gravityview",
"description": "Modify the tooltip HTML before outputting.",
"parameters": [
{
"name": "tooltip",
"type": "string",
"description": "The tooltip HTML."
},
{
"name": "article",
"type": "array",
"description": "Article data array."
},
{
"name": "url",
"type": "string",
"description": "The tooltip URL."
},
{
"name": "atts",
"type": "string",
"description": "HTML attributes string."
},
{
"name": "css_class",
"type": "string",
"description": "CSS class string."
},
{
"name": "tooltip_text",
"type": "string",
"description": "The tooltip text."
},
{
"name": "anchor_text",
"type": "string",
"description": "The anchor text HTML."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/tooltips/tooltip', function($tooltip, $article, $url, $atts, $css_class, $tooltip_text, $anchor_text) {\n // Modify $tooltip as needed\n return $tooltip;\n}, 10, 7 );",
"since": "2.10",
"source": {
"file": "src/Admin/Rendering/FieldType.php",
"line": 202
},
"url": "/docs/gravityview/filters/gravityview-tooltips-tooltip/",
"related": []
},
{
"id": "gravityview-view-anchor_id",
"name": "gravityview/view/anchor_id",
"type": "filter",
"product": "gravityview",
"description": "Modify the anchor ID.",
"parameters": [
{
"name": "anchor_id",
"type": "string",
"description": "The anchor ID."
},
{
"name": "this",
"type": "\\GV\\View",
"description": "The View."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/view/anchor_id', function($anchor_id, $this) {\n // Modify $anchor_id as needed\n return $anchor_id;\n}, 10, 2 );",
"since": "2.15",
"source": {
"file": "src/View/View.php",
"line": 2899
},
"url": "/docs/gravityview/filters/gravityview-view-anchor_id/",
"related": [
"gravityview/view/get",
"gravityview/view/query",
"gravityview/view/can_render",
"gravityview/view/entries",
"gravityview/view/fields"
]
},
{
"id": "gravityview-view-can_render",
"name": "gravityview/view/can_render",
"type": "filter",
"product": "gravityview",
"description": "Whether the view can be rendered or not.",
"parameters": [
{
"name": "allow_render",
"type": "null\\",
"description": "bool\\"
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The view."
},
{
"name": "context",
"type": "string[]",
"description": "Render contexts, e.g. shortcode, lightbox, rest, csv; see \\GV\\View::can_render for the full list. Return a WP_Error to deny a specific context (e.g. the entry lightbox)."
},
{
"name": "request",
"type": "\\Request\\",
"description": "\\WP_REST_Request\\"
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview/view/can_render', function($allow_render, $view, $context, $request) {\n // Modify $allow_render as needed\n return $allow_render;\n}, 10, 4 );",
"since": null,
"source": {
"file": "src/View/View.php",
"line": 561
},
"url": "/docs/gravityview/filters/gravityview-view-can_render/",
"related": [
"gravityview/view/get",
"gravityview/view/query",
"gravityview/view/anchor_id",
"gravityview/view/entries",
"gravityview/view/fields"
]
},
{
"id": "gravityview-view-configuration-fields",
"name": "gravityview/view/configuration/fields",
"type": "filter",
"product": "gravityview",
"description": "Filter the View fields' configuration array.",
"parameters": [
{
"name": "fields",
"type": "array",
"description": "Multi-array of fields with first level being the field zones."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View the fields are being pulled for."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/view/configuration/fields', function($fields, $view) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/View/View.php",
"line": 1421
},
"url": "/docs/gravityview/filters/gravityview-view-configuration-fields/",
"related": [
"gravityview/view/configuration/widgets"
]
},
{
"id": "gravityview-view-configuration-widgets",
"name": "gravityview/view/configuration/widgets",
"type": "filter",
"product": "gravityview",
"description": "Filter the View widgets' configuration array.",
"parameters": [
{
"name": "fields",
"type": "array",
"description": "Multi-array of widgets with first level being the field zones."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View the widgets are being pulled for."
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/view/configuration/widgets', function($fields, $view) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/View/View.php",
"line": 1441
},
"url": "/docs/gravityview/filters/gravityview-view-configuration-widgets/",
"related": [
"gravityview/view/configuration/fields"
]
},
{
"id": "gravityview-view-entries",
"name": "gravityview/view/entries",
"type": "filter",
"product": "gravityview",
"description": "Modify the entry fetching filters, sorts, offsets, limits.",
"parameters": [
{
"name": "entries",
"type": "\\GV\\Entry_Collection",
"description": "The entries for this view."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The view."
},
{
"name": "request",
"type": "\\Request\\",
"description": "null`"
},
{
"name": "position",
"type": "int\\",
"description": "null`"
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview/view/entries', function($entries, $view, $request, $position) {\n // Modify $entries as needed\n return $entries;\n}, 10, 4 );",
"since": "2.0",
"source": {
"file": "src/View/View.php",
"line": 2434
},
"url": "/docs/gravityview/filters/gravityview-view-entries/",
"related": [
"gravityview/view/get",
"gravityview/view/query",
"gravityview/view/anchor_id",
"gravityview/view/can_render",
"gravityview/view/fields"
]
},
{
"id": "gravityview-view-fields",
"name": "gravityview/view/fields",
"type": "filter",
"product": "gravityview",
"description": "Filter the Field Collection for this View.",
"parameters": [
{
"name": "fields",
"type": "\\GV\\Field_Collection",
"description": "A collection of fields."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View the fields are being pulled for."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview/view/fields', function($fields, $view) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/View/View.php",
"line": 1431
},
"url": "/docs/gravityview/filters/gravityview-view-fields/",
"related": [
"gravityview/view/get",
"gravityview/view/query",
"gravityview/view/anchor_id",
"gravityview/view/can_render",
"gravityview/view/entries"
]
},
{
"id": "gravityview-view-get_entries-should_apply_legacy_join_is_approved_query_conditions",
"name": "gravityview/view/get_entries/should_apply_legacy_join_is_approved_query_conditions",
"type": "filter",
"product": "gravityview",
"description": "Allows Multiple Forms and other plugins to deactivate this piece of functionality when loaded.",
"parameters": [
{
"name": "should_apply",
"type": "bool",
"description": "Determines if legacy join condition should be applied."
},
{
"name": "query",
"type": "\\GF_Query",
"description": "Which is being dealt with."
},
{
"name": "join",
"type": "\\GV\\Join",
"description": "Which join we are dealing with."
},
{
"name": "view",
"type": "self",
"description": "Instance of the view we are dealing with."
}
],
"categories": [
"entries",
"views",
"approval"
],
"example": "add_filter( 'gravityview/view/get_entries/should_apply_legacy_join_is_approved_query_conditions', function($should_apply, $query, $join, $view) {\n // Modify $should_apply as needed\n return $should_apply;\n}, 10, 4 );",
"since": "2.17.2",
"source": {
"file": "src/View/View.php",
"line": 2948
},
"url": "/docs/gravityview/filters/gravityview-view-get_entries-should_apply_legacy_join_is_approved_query_conditions/",
"related": []
},
{
"id": "gravityview-view-links-directory",
"name": "gravityview/view/links/directory",
"type": "filter",
"product": "gravityview",
"description": "Modify the URL to the View \"directory\" context.",
"parameters": [
{
"name": "permalink",
"type": "string",
"description": "URL to the View's \"directory\" context (Multiple Entries screen)."
},
{
"name": "view",
"type": "\\GV\\View|null",
"description": "The View context."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/view/links/directory', function($permalink, $view) {\n // Modify $permalink as needed\n return $permalink;\n}, 10, 2 );",
"since": "2.55.0",
"source": {
"file": "src/Entry/Entry.php",
"line": 225
},
"url": "/docs/gravityview/filters/gravityview-view-links-directory/",
"related": []
},
{
"id": "gravityview-view-output-direct",
"name": "gravityview/view/output/direct",
"type": "filter",
"product": "gravityview",
"description": "Should this View be directly accessible?",
"parameters": [
{
"name": "direct_access",
"type": "bool",
"description": "Whether the View is directly accessible. Default: true."
},
{
"name": "view",
"type": "\\View",
"description": "The View we're trying to directly render here."
},
{
"name": "request",
"type": "\\GV\\Request",
"description": "The current request."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/view/output/direct', function($direct_access, $view, $request) {\n // Modify $direct_access as needed\n return $direct_access;\n}, 10, 3 );",
"since": "2.0",
"source": {
"file": "src/View/DirectAccess.php",
"line": 468
},
"url": "/docs/gravityview/filters/gravityview-view-output-direct/",
"related": [
"gravityview/view/output/rest"
]
},
{
"id": "gravityview-view-output-rest",
"name": "gravityview/view/output/rest",
"type": "filter",
"product": "gravityview",
"description": "Disable REST output. Final chance.",
"parameters": [
{
"name": "enable",
"type": "bool",
"description": "Whether to enable REST output. Default: true."
},
{
"name": "view",
"type": "\\View",
"description": "The View being accessed."
}
],
"categories": [
"views",
"api"
],
"example": "add_filter( 'gravityview/view/output/rest', function($enable, $view) {\n // Modify $enable as needed\n return $enable;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/REST/ViewsRoute.php",
"line": 547
},
"url": "/docs/gravityview/filters/gravityview-view-output-rest/",
"related": [
"gravityview/view/output/direct"
]
},
{
"id": "gravityview-view-settings-defaults",
"name": "gravityview/view/settings/defaults",
"type": "filter",
"product": "gravityview",
"description": "Modify the default settings for new Views.",
"parameters": [
{
"name": "default_settings",
"type": "array",
"description": "Array of default settings."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/view/settings/defaults', function($default_settings) {\n // Modify $default_settings as needed\n return $default_settings;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Settings/ViewSettings.php",
"line": 947
},
"url": "/docs/gravityview/filters/gravityview-view-settings-defaults/",
"related": []
},
{
"id": "gravityview-view-widgets-default",
"name": "gravityview/view/widgets/default",
"type": "filter",
"product": "gravityview",
"description": "Modify the default widgets for new Views.",
"parameters": [
{
"name": "widgets",
"type": "array",
"description": "A Widget configuration array."
},
{
"name": "template_id",
"type": "string",
"description": "The current slug of the selected View template."
},
{
"name": "zone",
"type": "string",
"description": "The widget zone that's being requested."
},
{
"name": "post_id",
"type": "int",
"description": "The auto-draft post ID."
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/view/widgets/default', function($widgets, $template_id, $zone, $post_id) {\n // Modify $widgets as needed\n return $widgets;\n}, 10, 4 );",
"since": "2.10",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 1987
},
"url": "/docs/gravityview/filters/gravityview-view-widgets-default/",
"related": []
},
{
"id": "gravityview-view-widgets",
"name": "gravityview/view/widgets",
"type": "filter",
"product": "gravityview",
"description": "Filter the Widget Collection for this View.",
"parameters": [
{
"name": "widgets",
"type": "\\GV\\Widget_Collection",
"description": "A collection of widgets."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View the widgets are being pulled for."
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/view/widgets', function($widgets, $view) {\n // Modify $widgets as needed\n return $widgets;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/View/View.php",
"line": 1451
},
"url": "/docs/gravityview/filters/gravityview-view-widgets/",
"related": [
"gravityview/view/get",
"gravityview/view/query",
"gravityview/view/anchor_id",
"gravityview/view/can_render",
"gravityview/view/entries"
]
},
{
"id": "gravityview-view-wrapper_container",
"name": "gravityview/view/wrapper_container",
"type": "filter",
"product": "gravityview",
"description": "Modify the wrapper container.",
"parameters": [
{
"name": "wrapper_container",
"type": "string",
"description": "Wrapper container HTML markup"
},
{
"name": "anchor_id",
"type": "string",
"description": "(optional) Unique anchor ID to identify the view."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View."
}
],
"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.15",
"source": {
"file": "templates/views/gravityview-layout-builder.php",
"line": 188
},
"url": "/docs/gravityview/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-view_collection-from_post-meta_keys",
"name": "gravityview/view_collection/from_post/meta_keys",
"type": "filter",
"product": "gravityview",
"description": "Define meta keys to parse to check for GravityView shortcode content.",
"parameters": [
{
"name": "meta_keys",
"type": "array",
"description": "Array of key values to check. If empty, do not check. Default: empty array."
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "The post that is being checked."
},
{
"name": "views",
"type": "\\GV\\View_Collection",
"description": "The current View Collection object, passed as reference."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview/view_collection/from_post/meta_keys', function($meta_keys, $post, $views) {\n // Modify $meta_keys as needed\n return $meta_keys;\n}, 10, 3 );",
"since": "2.0",
"source": {
"file": "src/View/ViewCollection.php",
"line": 151
},
"url": "/docs/gravityview/filters/gravityview-view_collection-from_post-meta_keys/",
"related": []
},
{
"id": "gravityview-widget-active_areas",
"name": "gravityview/widget/active_areas",
"type": "filter",
"product": "gravityview",
"description": "Array of zones available for widgets to be dropped into.",
"parameters": [
{
"name": "default_areas",
"type": "array",
"description": "Definition for default widget areas"
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/active_areas', function($default_areas) {\n // Modify $default_areas as needed\n return $default_areas;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Widget/Widget.php",
"line": 278
},
"url": "/docs/gravityview/filters/gravityview-widget-active_areas/",
"related": [
"gravityview/widget/enable_custom_class",
"gravityview/widget/hide_until_searched",
"gravityview/widget/update"
]
},
{
"id": "gravityview-widget-enable_custom_class",
"name": "gravityview/widget/enable_custom_class",
"type": "filter",
"product": "gravityview",
"description": "Enable custom CSS class settings for widgets.",
"parameters": [
{
"name": "enable_custom_class",
"type": "bool",
"description": "False by default. Return true if you want to enable."
},
{
"name": "this",
"type": "\\GV\\Widget",
"description": "Current instance of \\GV\\Widget."
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/enable_custom_class', function($enable_custom_class, $this) {\n // Modify $enable_custom_class as needed\n return $enable_custom_class;\n}, 10, 2 );",
"since": "1.5.4",
"source": {
"file": "src/Widget/Widget.php",
"line": 203
},
"url": "/docs/gravityview/filters/gravityview-widget-enable_custom_class/",
"related": [
"gravityview/widget/active_areas",
"gravityview/widget/hide_until_searched",
"gravityview/widget/update"
]
},
{
"id": "gravityview-widget-hide_until_searched-allowlist",
"name": "gravityview/widget/hide_until_searched/allowlist",
"type": "filter",
"product": "gravityview",
"description": "Some widgets have got to stay shown.",
"parameters": [
{
"name": "allowlist",
"type": "string[]",
"description": "The widget IDs that have to be shown by default."
}
],
"categories": [
"search",
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/hide_until_searched/allowlist', function($allowlist) {\n // Modify $allowlist as needed\n return $allowlist;\n}, 10, 1 );",
"since": "2.14",
"source": {
"file": "src/Widget/Widget.php",
"line": 456
},
"url": "/docs/gravityview/filters/gravityview-widget-hide_until_searched-allowlist/",
"related": [
"gravityview/widget/hide_until_searched/whitelist"
]
},
{
"id": "gravityview-widget-hide_until_searched-whitelist",
"name": "gravityview/widget/hide_until_searched/whitelist",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/hide_until_searched/whitelist', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Widget/Widget.php",
"line": 448
},
"url": "/docs/gravityview/filters/gravityview-widget-hide_until_searched-whitelist/",
"related": [
"gravityview/widget/hide_until_searched/allowlist"
]
},
{
"id": "gravityview-widget-hide_until_searched",
"name": "gravityview/widget/hide_until_searched",
"type": "filter",
"product": "gravityview",
"description": "Modify whether to hide content until search.",
"parameters": [
{
"name": "hide_until_searched",
"type": "bool",
"description": "Hide until search?"
},
{
"name": "this",
"type": "\\GV\\Widget",
"description": "Widget instance."
}
],
"categories": [
"search",
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/hide_until_searched', function($hide_until_searched, $this) {\n // Modify $hide_until_searched as needed\n return $hide_until_searched;\n}, 10, 2 );",
"since": "1.5.4",
"source": {
"file": "src/Widget/Widget.php",
"line": 474
},
"url": "/docs/gravityview/filters/gravityview-widget-hide_until_searched/",
"related": [
"gravityview/widget/active_areas",
"gravityview/widget/enable_custom_class",
"gravityview/widget/update"
]
},
{
"id": "gravityview-widget-page_size-page_sizes",
"name": "gravityview/widget/page_size/page_sizes",
"type": "filter",
"product": "gravityview",
"description": "Filter the available page sizes as needed.",
"parameters": [
{
"name": "sizes",
"type": "array",
"description": "The sizes, with value and text keys. text key used as HTML option label."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/page_size/page_sizes', function($sizes, $context) {\n // Modify $sizes as needed\n return $sizes;\n}, 10, 2 );",
"since": "2.1",
"source": {
"file": "src/Widget/Types/PageSize.php",
"line": 96
},
"url": "/docs/gravityview/filters/gravityview-widget-page_size-page_sizes/",
"related": [
"gravityview/widget/page_size/settings"
]
},
{
"id": "gravityview-widget-page_size-settings",
"name": "gravityview/widget/page_size/settings",
"type": "filter",
"product": "gravityview",
"description": "Filter the settings for the widget.",
"parameters": [
{
"name": "settings",
"type": "array",
"description": "Configuration for how output will display, with label, choices, default_choice_text keys."
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/page_size/settings', function($settings, $context) {\n // Modify $settings as needed\n return $settings;\n}, 10, 2 );",
"since": "2.1",
"source": {
"file": "src/Widget/Types/PageSize.php",
"line": 134
},
"url": "/docs/gravityview/filters/gravityview-widget-page_size-settings/",
"related": [
"gravityview/widget/page_size/page_sizes"
]
},
{
"id": "gravityview-widget-poll-settings",
"name": "gravityview/widget/poll/settings",
"type": "filter",
"product": "gravityview",
"description": "Modifies display settings for the poll widget.",
"parameters": [
{
"name": "settings",
"type": "array",
"description": "Settings with field, style, percentages and counts keys."
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/poll/settings', function($settings) {\n // Modify $settings as needed\n return $settings;\n}, 10, 1 );",
"since": "1.8",
"source": {
"file": "src/Widget/Types/Poll.php",
"line": 188
},
"url": "/docs/gravityview/filters/gravityview-widget-poll-settings/",
"related": []
},
{
"id": "gravityview-widget-recent-entries-output",
"name": "gravityview/widget/recent-entries/output",
"type": "filter",
"product": "gravityview",
"description": "Modify the HTML before it's echo'd",
"parameters": [
{
"name": "output",
"type": "string",
"description": "HTML to be displayed"
},
{
"name": "instance",
"type": "array",
"description": "Widget settings"
}
],
"categories": [
"entries",
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/recent-entries/output', function($output, $instance) {\n // Modify $output as needed\n return $output;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/Widget/WordPress/RecentEntriesWidget.php",
"line": 208
},
"url": "/docs/gravityview/filters/gravityview-widget-recent-entries-output/",
"related": [
"gravityview/widget/recent-entries/after_widget",
"gravityview/widget/recent-entries/before_widget"
]
},
{
"id": "gravityview-widget-search-append_view_id_anchor",
"name": "gravityview/widget/search/append_view_id_anchor",
"type": "filter",
"product": "gravityview",
"description": "Allow appending the View ID anchor to the search URL.",
"parameters": [
{
"name": "append_anchor",
"type": "bool",
"description": "Whether to append the View ID anchor to the search URL. Default: true."
}
],
"categories": [
"search",
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/search/append_view_id_anchor', function($append_anchor) {\n // Modify $append_anchor as needed\n return $append_anchor;\n}, 10, 1 );",
"since": "2.15",
"source": {
"file": "src/Renderer/ViewRenderer.php",
"line": 161
},
"url": "/docs/gravityview/filters/gravityview-widget-search-append_view_id_anchor/",
"related": []
},
{
"id": "gravityview-widget-search-form-action",
"name": "gravityview/widget/search/form/action",
"type": "filter",
"product": "gravityview",
"description": "Override the search URL.",
"parameters": [
{
"name": "url",
"type": "string",
"description": "The search form action URL."
},
{
"name": "view_id",
"type": "int",
"description": "The View ID being rendered. 0 if unavailable."
}
],
"categories": [
"search",
"views",
"forms",
"widgets"
],
"example": "add_filter( 'gravityview/widget/search/form/action', function($url, $view_id) {\n // Modify $url as needed\n return $url;\n}, 10, 2 );",
"since": "1.6",
"source": {
"file": "src/Widget/Types/SearchWidget.php",
"line": 1174
},
"url": "/docs/gravityview/filters/gravityview-widget-search-form-action/",
"related": []
},
{
"id": "gravityview-widget-update",
"name": "gravityview/widget/update",
"type": "filter",
"product": "gravityview",
"description": "Modify the updated instance. This will allow for validating any added instance settings externally.",
"parameters": [
{
"name": "instance",
"type": "array",
"description": "Calculated widget settings after processing"
},
{
"name": "new_instance",
"type": "array",
"description": "Widget form settings after update"
},
{
"name": "old_instance",
"type": "array",
"description": "Widget form settings before update"
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widget/update', function($instance, $new_instance, $old_instance) {\n // Modify $instance as needed\n return $instance;\n}, 10, 3 );",
"since": null,
"source": {
"file": "src/Widget/WordPress/RecentEntriesWidget.php",
"line": 280
},
"url": "/docs/gravityview/filters/gravityview-widget-update/",
"related": [
"gravityview/widget/active_areas",
"gravityview/widget/enable_custom_class",
"gravityview/widget/hide_until_searched"
]
},
{
"id": "gravityview-widgets-register",
"name": "gravityview/widgets/register",
"type": "filter",
"product": "gravityview",
"description": "Each item is used to instantiate a GravityView_Admin_View_Widget object.",
"parameters": [
{
"name": "registered_widgets",
"type": "array",
"description": "Empty array."
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widgets/register', function($registered_widgets) {\n // Modify $registered_widgets as needed\n return $registered_widgets;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Widget/Widget.php",
"line": 607
},
"url": "/docs/gravityview/filters/gravityview-widgets-register/",
"related": [
"gravityview/widgets/wrapper_css_class"
]
},
{
"id": "gravityview-widgets-search-created_by-user_fields",
"name": "gravityview/widgets/search/created_by/user_fields",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "user_fields",
"type": "array",
"description": "The user fields."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View."
}
],
"categories": [
"fields",
"search",
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widgets/search/created_by/user_fields', function($user_fields, $view) {\n // Modify $user_fields as needed\n return $user_fields;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/Widget/Types/SearchWidgetAuthorCondition.php",
"line": 108
},
"url": "/docs/gravityview/filters/gravityview-widgets-search-created_by-user_fields/",
"related": [
"gravityview/widgets/search/created_by/user_meta_fields"
]
},
{
"id": "gravityview-widgets-search-created_by-user_meta_fields",
"name": "gravityview/widgets/search/created_by/user_meta_fields",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "user_meta_fields",
"type": "array",
"description": "The user meta fields."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View."
}
],
"categories": [
"fields",
"search",
"views",
"widgets"
],
"example": "add_filter( 'gravityview/widgets/search/created_by/user_meta_fields', function($user_meta_fields, $view) {\n // Modify $user_meta_fields as needed\n return $user_meta_fields;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/Widget/Types/SearchWidgetAuthorCondition.php",
"line": 87
},
"url": "/docs/gravityview/filters/gravityview-widgets-search-created_by-user_meta_fields/",
"related": [
"gravityview/widgets/search/created_by/user_fields"
]
},
{
"id": "gravityview-widgets-search-datepicker-format",
"name": "gravityview/widgets/search/datepicker/format",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"search",
"views",
"forms",
"widgets"
],
"example": "add_filter( 'gravityview/widgets/search/datepicker/format', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/SearchPolicy.php",
"line": 237
},
"url": "/docs/gravityview/filters/gravityview-widgets-search-datepicker-format/",
"related": []
},
{
"id": "gravityview-widgets-wrapper_css_class",
"name": "gravityview/widgets/wrapper_css_class",
"type": "filter",
"product": "gravityview",
"description": "The CSS class applied to the widget container div.",
"parameters": [
{
"name": "css_class",
"type": "string",
"description": "Default: gv-grid gv-widgets-\\{zone\\} where \\{zone\\} is replaced by the current $zone value. If the View has no results, adds gv-widgets-no-results."
},
{
"name": "zone",
"type": "string",
"description": "Current widget zone, either header or footer."
},
{
"name": "widgets",
"type": "array",
"description": "Array of widget configurations for the current zone."
}
],
"categories": [
"views",
"widgets",
"assets"
],
"example": "add_filter( 'gravityview/widgets/wrapper_css_class', function($css_class, $zone, $widgets) {\n // Modify $css_class as needed\n return $css_class;\n}, 10, 3 );",
"since": "1.16.2",
"source": {
"file": "src/View/ViewLegacy.php",
"line": 1130
},
"url": "/docs/gravityview/filters/gravityview-widgets-wrapper_css_class/",
"related": [
"gravityview/widgets/register"
]
},
{
"id": "gravityview_additional_fields",
"name": "gravityview_additional_fields",
"type": "filter",
"product": "gravityview",
"description": "Modify the non-standard fields shown at the bottom of the field picker.",
"parameters": [
{
"name": "additional_fields",
"type": "array",
"description": "Associative array of field arrays, with label_text, desc, field_id, label_type, input_type, field_options, and settings_html keys."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview_additional_fields', function($additional_fields) {\n // Modify $additional_fields as needed\n return $additional_fields;\n}, 10, 1 );",
"since": "1.0.7-beta",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 1344
},
"url": "/docs/gravityview/filters/gravityview_additional_fields/",
"related": []
},
{
"id": "gravityview_admin_label_item_info",
"name": "gravityview_admin_label_item_info",
"type": "filter",
"product": "gravityview",
"description": "Tap in to modify the field information displayed next to an item.",
"parameters": [
{
"name": "field_info_items",
"type": "array",
"description": "Additional information to display in a field."
},
{
"name": "field",
"type": "\\GravityView_Admin_View_Field",
"description": "Field shown in the admin."
}
],
"categories": [
"views",
"admin"
],
"example": "add_filter( 'gravityview_admin_label_item_info', function($field_info_items, $field) {\n // Modify $field_info_items as needed\n return $field_info_items;\n}, 10, 2 );",
"since": "1.17.3",
"source": {
"file": "src/Admin/ViewItem.php",
"line": 137
},
"url": "/docs/gravityview/filters/gravityview_admin_label_item_info/",
"related": []
},
{
"id": "gravityview_anchor_text_noquerystring",
"name": "gravityview_anchor_text_noquerystring",
"type": "filter",
"product": "gravityview",
"description": "Strip the query string from the end of the URL?",
"parameters": [
{
"name": "enable",
"type": "bool",
"description": "Whether to strip the query string. Return false to show query string. Default: true. If true: http://example.com/?query=example => example.com"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_anchor_text_noquerystring', function($enable) {\n // Modify $enable as needed\n return $enable;\n}, 10, 1 );",
"since": "1.5.1",
"source": {
"file": "src/Utils/helper-functions.php",
"line": 432
},
"url": "/docs/gravityview/filters/gravityview_anchor_text_noquerystring/",
"related": []
},
{
"id": "gravityview_anchor_text_nosubdomain",
"name": "gravityview_anchor_text_nosubdomain",
"type": "filter",
"product": "gravityview",
"description": "Strip subdomains from the domain?",
"parameters": [
{
"name": "enable",
"type": "bool",
"description": "Whether to strip subdomains. Return false to show subdomains. Default: true. If true: http://demo.example.com => example.com If false: http://demo.example.com => demo.example.com"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_anchor_text_nosubdomain', function($enable) {\n // Modify $enable as needed\n return $enable;\n}, 10, 1 );",
"since": "1.5.1",
"source": {
"file": "src/Utils/helper-functions.php",
"line": 395
},
"url": "/docs/gravityview/filters/gravityview_anchor_text_nosubdomain/",
"related": []
},
{
"id": "gravityview_anchor_text_rootonly",
"name": "gravityview_anchor_text_rootonly",
"type": "filter",
"product": "gravityview",
"description": "Display link path going only to the base directory, not a sub-directory or file?",
"parameters": [
{
"name": "enable",
"type": "bool",
"description": "Whether to enable \"root only\". Return false to show full path. Default: true. If true: http://example.com/sub/directory/page.html => example.com If false: http://example.com/sub/directory/page.html => example.com/sub/directory/page.html"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_anchor_text_rootonly', function($enable) {\n // Modify $enable as needed\n return $enable;\n}, 10, 1 );",
"since": "1.5.1",
"source": {
"file": "src/Utils/helper-functions.php",
"line": 415
},
"url": "/docs/gravityview/filters/gravityview_anchor_text_rootonly/",
"related": []
},
{
"id": "gravityview_anchor_text_striphttp",
"name": "gravityview_anchor_text_striphttp",
"type": "filter",
"product": "gravityview",
"description": "Strip scheme from the displayed URL?",
"parameters": [
{
"name": "enable",
"type": "bool",
"description": "Whether to strip the scheme. Return false to show scheme. Default: true. If true: http://example.com => example.com"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_anchor_text_striphttp', function($enable) {\n // Modify $enable as needed\n return $enable;\n}, 10, 1 );",
"since": "1.5.1",
"source": {
"file": "src/Utils/helper-functions.php",
"line": 362
},
"url": "/docs/gravityview/filters/gravityview_anchor_text_striphttp/",
"related": []
},
{
"id": "gravityview_anchor_text_stripwww",
"name": "gravityview_anchor_text_stripwww",
"type": "filter",
"product": "gravityview",
"description": "Strip www from the domain?",
"parameters": [
{
"name": "enable",
"type": "bool",
"description": "Whether to strip www. Return false to show www. Default: true. If true: www.example.com => example.com"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_anchor_text_stripwww', function($enable) {\n // Modify $enable as needed\n return $enable;\n}, 10, 1 );",
"since": "1.5.1",
"source": {
"file": "src/Utils/helper-functions.php",
"line": 380
},
"url": "/docs/gravityview/filters/gravityview_anchor_text_stripwww/",
"related": []
},
{
"id": "gravityview_assign_new_user_to_entry",
"name": "gravityview_assign_new_user_to_entry",
"type": "filter",
"product": "gravityview",
"description": "Disable assigning the new user to the entry by returning false.",
"parameters": [
{
"name": "assign_to_lead",
"type": "bool",
"description": "Whether to assign the new user to the entry. Default: true."
},
{
"name": "user_id",
"type": "int",
"description": "WordPress User ID."
},
{
"name": "config",
"type": "array",
"description": "User registration feed configuration."
},
{
"name": "entry",
"type": "array",
"description": "GF Entry array."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_assign_new_user_to_entry', function($assign_to_lead, $user_id, $config, $entry) {\n // Modify $assign_to_lead as needed\n return $assign_to_lead;\n}, 10, 4 );",
"since": "1.10",
"source": {
"file": "src/Entry/ChangeEntryCreator.php",
"line": 247
},
"url": "/docs/gravityview/filters/gravityview_assign_new_user_to_entry/",
"related": []
},
{
"id": "gravityview_audio_settings",
"name": "gravityview_audio_settings",
"type": "filter",
"product": "gravityview",
"description": "Modify the default attributes that will be passed to the wp_audio_shortcode() function.",
"parameters": [
{
"name": "audio_settings",
"type": "array",
"description": "Array with src and class keys."
},
{
"name": "context",
"type": "\\Template_Context",
"description": "The context."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_audio_settings', function($audio_settings, $context) {\n // Modify $audio_settings as needed\n return $audio_settings;\n}, 10, 2 );",
"since": "1.2",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 344
},
"url": "/docs/gravityview/filters/gravityview_audio_settings/",
"related": []
},
{
"id": "gravityview_blacklist_field_types",
"name": "gravityview_blacklist_field_types",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview_blacklist_field_types', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 1730
},
"url": "/docs/gravityview/filters/gravityview_blacklist_field_types/",
"related": []
},
{
"id": "gravityview_blocklist_field_types",
"name": "gravityview_blocklist_field_types",
"type": "filter",
"product": "gravityview",
"description": "Modify the list of field types that should not be sortable.",
"parameters": [
{
"name": "blocklist_field_types",
"type": "array",
"description": "Array of field types to exclude from sorting."
},
{
"name": "context",
"type": "array\\",
"description": "null`"
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview_blocklist_field_types', function($blocklist_field_types, $context) {\n // Modify $blocklist_field_types as needed\n return $blocklist_field_types;\n}, 10, 2 );",
"since": "2.14",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 1740
},
"url": "/docs/gravityview/filters/gravityview_blocklist_field_types/",
"related": []
},
{
"id": "gravityview_cache_time_.filter_name",
"name": "gravityview_cache_time_ . $filter_name",
"type": "filter",
"product": "gravityview",
"description": "Modify the cache time for a type of cache.",
"parameters": [
{
"name": "expiration",
"type": "int",
"description": "Cache time in seconds. Default: DAY_IN_SECONDS."
}
],
"categories": [
"search",
"views",
"caching"
],
"example": "add_filter( 'gravityview_cache_time_ . $filter_name', function($expiration) {\n // Modify $expiration as needed\n return $expiration;\n}, 10, 1 );",
"since": "1.3",
"source": {
"file": "src/Data/Cache.php",
"line": 579
},
"url": "/docs/gravityview/filters/gravityview_cache_time_.filter_name/",
"related": []
},
{
"id": "gravityview_change_entry_creator_user_parameters",
"name": "gravityview_change_entry_creator_user_parameters",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "settings",
"type": "array",
"description": "Settings array, with number key defining the # of users to display."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_change_entry_creator_user_parameters', function($settings) {\n // Modify $settings as needed\n return $settings;\n}, 10, 1 );",
"since": "1.8",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 2120
},
"url": "/docs/gravityview/filters/gravityview_change_entry_creator_user_parameters/",
"related": []
},
{
"id": "gravityview_cleanup_transients",
"name": "gravityview_cleanup_transients",
"type": "filter",
"product": "gravityview",
"description": "Override GravityView cleanup of transients by setting this to false.",
"parameters": [
{
"name": "cleanup",
"type": "bool",
"description": "Whether to run the GravityView auto-cleanup of transients. Default: true."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_cleanup_transients', function($cleanup) {\n // Modify $cleanup as needed\n return $cleanup;\n}, 10, 1 );",
"since": "1.3",
"source": {
"file": "src/Data/Cache.php",
"line": 665
},
"url": "/docs/gravityview/filters/gravityview_cleanup_transients/",
"related": []
},
{
"id": "gravityview_connected_form_links",
"name": "gravityview_connected_form_links",
"type": "filter",
"product": "gravityview",
"description": "Modify the links shown in the Connected Form links.",
"parameters": [
{
"name": "links",
"type": "array",
"description": "Links to show."
},
{
"name": "form",
"type": "array",
"description": "Gravity Forms form array."
}
],
"categories": [
"views",
"forms"
],
"example": "add_filter( 'gravityview_connected_form_links', function($links, $form) {\n // Modify $links as needed\n return $links;\n}, 10, 2 );",
"since": "1.6",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 824
},
"url": "/docs/gravityview/filters/gravityview_connected_form_links/",
"related": []
},
{
"id": "gravityview_custom_entry_slug",
"name": "gravityview_custom_entry_slug",
"type": "filter",
"product": "gravityview",
"description": "Filter whether to enable custom entry slugs.",
"parameters": [
{
"name": "enable_custom_slug",
"type": "bool",
"description": "Whether to enable custom entry slugs. Default: false."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_custom_entry_slug', function($enable_custom_slug) {\n // Modify $enable_custom_slug as needed\n return $enable_custom_slug;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Entry/EntryGravityForms.php",
"line": 77
},
"url": "/docs/gravityview/filters/gravityview_custom_entry_slug/",
"related": []
},
{
"id": "gravityview_custom_entry_slug_allow_id",
"name": "gravityview_custom_entry_slug_allow_id",
"type": "filter",
"product": "gravityview",
"description": "When using a custom slug, allow access to the entry using the original slug (the Entry ID).",
"parameters": [
{
"name": "custom_slug_id_access",
"type": "bool",
"description": "True: allow accessing the slug by ID; False: only use the slug passed to the method."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_custom_entry_slug_allow_id', function($custom_slug_id_access) {\n // Modify $custom_slug_id_access as needed\n return $custom_slug_id_access;\n}, 10, 1 );",
"since": "1.5.1",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 911
},
"url": "/docs/gravityview/filters/gravityview_custom_entry_slug_allow_id/",
"related": []
},
{
"id": "gravityview_date_created_adjust_timezone",
"name": "gravityview_date_created_adjust_timezone",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_date_created_adjust_timezone', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Search/SearchPolicy.php",
"line": 277
},
"url": "/docs/gravityview/filters/gravityview_date_created_adjust_timezone/",
"related": []
},
{
"id": "gravityview_date_format",
"name": "gravityview_date_format",
"type": "filter",
"product": "gravityview",
"description": "Override the date format with a PHP date format.",
"parameters": [
{
"name": "date_format",
"type": "string\\",
"description": "null`"
}
],
"categories": [
"views",
"forms"
],
"example": "add_filter( 'gravityview_date_format', function($date_format) {\n // Modify $date_format as needed\n return $date_format;\n}, 10, 1 );",
"since": "1.0-beta",
"source": {
"file": "src/Field/Types/GravityViewField.php",
"line": 551
},
"url": "/docs/gravityview/filters/gravityview_date_format/",
"related": []
},
{
"id": "gravityview_default_args",
"name": "gravityview_default_args",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "default_settings",
"type": "array",
"description": "Array of default settings."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_default_args', function($default_settings) {\n // Modify $default_settings as needed\n return $default_settings;\n}, 10, 1 );",
"since": "2.0",
"source": {
"file": "src/Settings/ViewSettings.php",
"line": 938
},
"url": "/docs/gravityview/filters/gravityview_default_args/",
"related": []
},
{
"id": "gravityview_default_page_size",
"name": "gravityview_default_page_size",
"type": "filter",
"product": "gravityview",
"description": "The default number of entries displayed in a View.",
"parameters": [
{
"name": "default_page_size",
"type": "int",
"description": "Default: 25"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_default_page_size', function($default_page_size) {\n // Modify $default_page_size as needed\n return $default_page_size;\n}, 10, 1 );",
"since": "1.1.6",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1500
},
"url": "/docs/gravityview/filters/gravityview_default_page_size/",
"related": []
},
{
"id": "gravityview_direct_access",
"name": "gravityview_direct_access",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "direct_access",
"type": "bool",
"description": "Whether Views may be accessed directly rather than only embedded. Default: true."
},
{
"name": "view_id",
"type": "int",
"description": "The ID of the View currently being requested. 0 for general setting"
}
],
"categories": [
"views",
"permissions"
],
"example": "add_filter( 'gravityview_direct_access', function($direct_access, $view_id) {\n // Modify $direct_access as needed\n return $direct_access;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/View/DirectAccess.php",
"line": 452
},
"url": "/docs/gravityview/filters/gravityview_direct_access/",
"related": []
},
{
"id": "gravityview_directory_endpoint",
"name": "gravityview_directory_endpoint",
"type": "filter",
"product": "gravityview",
"description": "Change the slug used for single entries.",
"parameters": [
{
"name": "endpoint",
"type": "string",
"description": "Slug to use when accessing single entry. Default: entry."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_directory_endpoint', function($endpoint) {\n // Modify $endpoint as needed\n return $endpoint;\n}, 10, 1 );",
"since": "1.0",
"source": {
"file": "src/Entry/Entry.php",
"line": 89
},
"url": "/docs/gravityview/filters/gravityview_directory_endpoint/",
"related": []
},
{
"id": "gravityview_directory_link",
"name": "gravityview_directory_link",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "link",
"type": "string",
"description": "URL to the View's \"directory\" context (Multiple Entries screen)"
},
{
"name": "post_id",
"type": "int",
"description": "ID of the post to link to. If the View is embedded, it is the post or page ID"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_directory_link', function($link, $post_id) {\n // Modify $link as needed\n return $link;\n}, 10, 2 );",
"since": "1.19.4",
"source": {
"file": "src/Entry/Entry.php",
"line": 215
},
"url": "/docs/gravityview/filters/gravityview_directory_link/",
"related": []
},
{
"id": "gravityview_disable_change_entry_creator",
"name": "gravityview_disable_change_entry_creator",
"type": "filter",
"product": "gravityview",
"description": "Disable the Change Entry Creator functionality.",
"parameters": [
{
"name": "disable",
"type": "bool",
"description": "Disable the Change Entry Creator functionality. Default: false."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_disable_change_entry_creator', function($disable) {\n // Modify $disable as needed\n return $disable;\n}, 10, 1 );",
"since": "1.7.4",
"source": {
"file": "src/Entry/ChangeEntryCreator.php",
"line": 72
},
"url": "/docs/gravityview/filters/gravityview_disable_change_entry_creator/",
"related": []
},
{
"id": "gravityview_disable_change_entry_creator_note",
"name": "gravityview_disable_change_entry_creator_note",
"type": "filter",
"product": "gravityview",
"description": "Disable adding a note when changing the entry creator.",
"parameters": [
{
"name": "disable",
"type": "bool",
"description": "Disable the Change Entry Creator note. Default: false."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_disable_change_entry_creator_note', function($disable) {\n // Modify $disable as needed\n return $disable;\n}, 10, 1 );",
"since": "1.21.5",
"source": {
"file": "src/Entry/ChangeEntryCreator.php",
"line": 276
},
"url": "/docs/gravityview/filters/gravityview_disable_change_entry_creator_note/",
"related": []
},
{
"id": "gravityview_edit_entry_title",
"name": "gravityview_edit_entry_title",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "edit_entry_title",
"type": "string",
"description": "Modify the \"Edit Entry\" title."
},
{
"name": "this",
"type": "\\GravityView_Edit_Entry_Render",
"description": "This object."
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview_edit_entry_title', function($edit_entry_title, $this) {\n // Modify $edit_entry_title as needed\n return $edit_entry_title;\n}, 10, 2 );",
"since": "1.1",
"source": {
"file": "src/Extension/EditEntry/EditEntryRender.php",
"line": 1747
},
"url": "/docs/gravityview/filters/gravityview_edit_entry_title/",
"related": []
},
{
"id": "gravityview_email_prevent_encrypt",
"name": "gravityview_email_prevent_encrypt",
"type": "filter",
"product": "gravityview",
"description": "Prevent encrypting emails no matter what - this is handy for DataTables exports, for example",
"parameters": [
{
"name": "prevent_encrypt",
"type": "bool",
"description": "Whether to prevent email encryption"
}
],
"categories": [
"views",
"calendar",
"notifications"
],
"example": "add_filter( 'gravityview_email_prevent_encrypt', function($prevent_encrypt) {\n // Modify $prevent_encrypt as needed\n return $prevent_encrypt;\n}, 10, 1 );",
"since": "1.1.6",
"source": {
"file": "templates/deprecated/fields/email.php",
"line": 64
},
"url": "/docs/gravityview/filters/gravityview_email_prevent_encrypt/",
"related": []
},
{
"id": "gravityview_empty_value",
"name": "gravityview_empty_value",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "value",
"type": "string",
"description": "(empty string)"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_empty_value', function($value) {\n // Modify $value as needed\n return $value;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/API/class-api.php",
"line": 318
},
"url": "/docs/gravityview/filters/gravityview_empty_value/",
"related": []
},
{
"id": "gravityview_entry_class",
"name": "gravityview_entry_class",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "alt",
"type": "string",
"description": "Existing class. Default: if odd row, alt, otherwise empty string."
},
{
"name": "entry",
"type": "array",
"description": "Current entry being displayed"
},
{
"name": "this",
"type": "\\GravityView_View",
"description": "Current GravityView_View object"
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_entry_class', function($alt, $entry, $this) {\n // Modify $alt as needed\n return $alt;\n}, 10, 3 );",
"since": null,
"source": {
"file": "templates/deprecated/table-body.php",
"line": 50
},
"url": "/docs/gravityview/filters/gravityview_entry_class/",
"related": []
},
{
"id": "gravityview_entry_default_fields",
"name": "gravityview_entry_default_fields",
"type": "filter",
"product": "gravityview",
"description": "Modify the default fields for each zone and context.",
"parameters": [
{
"name": "entry_default_fields",
"type": "array",
"description": "Array of fields shown by default."
},
{
"name": "form",
"type": "string\\",
"description": "array`"
},
{
"name": "zone",
"type": "string",
"description": "Either 'single', 'directory', 'header', 'footer'."
}
],
"categories": [
"entries",
"fields",
"views"
],
"example": "add_filter( 'gravityview_entry_default_fields', function($entry_default_fields, $form, $zone) {\n // Modify $entry_default_fields as needed\n return $entry_default_fields;\n}, 10, 3 );",
"since": "1.0-beta",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 1408
},
"url": "/docs/gravityview/filters/gravityview_entry_default_fields/",
"related": []
},
{
"id": "gravityview_entry_link",
"name": "gravityview_entry_link",
"type": "filter",
"product": "gravityview",
"description": "Modify the entry link anchor text.",
"parameters": [
{
"name": "link_text",
"type": "string",
"description": "The link anchor text after merge tag replacement."
},
{
"name": "gravityview",
"type": "\\GV\\Template_Context",
"description": "The template context."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_entry_link', function($link_text, $gravityview) {\n // Modify $link_text as needed\n return $link_text;\n}, 10, 2 );",
"since": "1.0-beta",
"source": {
"file": "templates/fields/field-delete_link-html.php",
"line": 48
},
"url": "/docs/gravityview/filters/gravityview_entry_link/",
"related": []
},
{
"id": "gravityview_entry_slug",
"name": "gravityview_entry_slug",
"type": "filter",
"product": "gravityview",
"description": "Modify the unique entry slug, which is used in the entry URL.",
"parameters": [
{
"name": "slug",
"type": "string",
"description": "Existing slug generated by GravityView (8-character hash by default)."
},
{
"name": "id",
"type": "string",
"description": "The entry ID."
},
{
"name": "entry",
"type": "array",
"description": "Entry data array. May be empty."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_entry_slug', function($slug, $id, $entry) {\n // Modify $slug as needed\n return $slug;\n}, 10, 3 );",
"since": "1.4",
"source": {
"file": "src/API/API.php",
"line": 609
},
"url": "/docs/gravityview/filters/gravityview_entry_slug/",
"related": []
},
{
"id": "gravityview_excerpt_more",
"name": "gravityview_excerpt_more",
"type": "filter",
"product": "gravityview",
"description": "Modify the \"Read more\" link used when \"Maximum Words\" setting is enabled and the output is truncated.",
"parameters": [
{
"name": "excerpt_more",
"type": "string",
"description": "Default: ..."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_excerpt_more', function($excerpt_more) {\n // Modify $excerpt_more as needed\n return $excerpt_more;\n}, 10, 1 );",
"since": "1.16.1",
"source": {
"file": "templates/deprecated/fields/textarea.php",
"line": 40
},
"url": "/docs/gravityview/filters/gravityview_excerpt_more/",
"related": []
},
{
"id": "gravityview_fe_search_criteria",
"name": "gravityview_fe_search_criteria",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "search_criteria",
"type": "array",
"description": "The search criteria array."
},
{
"name": "form_id",
"type": "int",
"description": "The form ID."
},
{
"name": "atts",
"type": "array",
"description": "View settings as attributes."
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview_fe_search_criteria', function($search_criteria, $form_id, $atts) {\n // Modify $search_criteria as needed\n return $search_criteria;\n}, 10, 3 );",
"since": "1.0",
"source": {
"file": "src/Widget/Types/SearchWidget.php",
"line": 871
},
"url": "/docs/gravityview/filters/gravityview_fe_search_criteria/",
"related": []
},
{
"id": "gravityview_field_entry_link",
"name": "gravityview_field_entry_link",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "link",
"type": "string",
"description": "HTML output of the link."
},
{
"name": "href",
"type": "string",
"description": "URL of the link."
},
{
"name": "entry",
"type": "array",
"description": "The GF entry array."
},
{
"name": "field_settings",
"type": "array",
"description": "Settings for the particular GV field."
}
],
"categories": [
"entries",
"fields",
"views"
],
"example": "add_filter( 'gravityview_field_entry_link', function($link, $href, $entry, $field_settings) {\n // Modify $link as needed\n return $link;\n}, 10, 4 );",
"since": "1.2",
"source": {
"file": "templates/fields/field-entry_link-html.php",
"line": 73
},
"url": "/docs/gravityview/filters/gravityview_field_entry_link/",
"related": []
},
{
"id": "gravityview_field_entry_value",
"name": "gravityview_field_entry_value",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "output",
"type": "string",
"description": "HTML value output."
},
{
"name": "entry",
"type": "array",
"description": "The GF entry array."
},
{
"name": "field_settings",
"type": "array",
"description": "Settings for the particular GV field."
},
{
"name": "field_data",
"type": "array",
"description": "Field data array."
}
],
"categories": [
"entries",
"fields",
"views"
],
"example": "add_filter( 'gravityview_field_entry_value', function($output, $entry, $field_settings, $field_data) {\n // Modify $output as needed\n return $output;\n}, 10, 4 );",
"since": "1.0",
"source": {
"file": "src/Template/TemplateField.php",
"line": 482
},
"url": "/docs/gravityview/filters/gravityview_field_entry_value/",
"related": []
},
{
"id": "gravityview_field_entry_value_field-type",
"name": "gravityview_field_entry_value_\\{$field->type\\}",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "output",
"type": "string",
"description": "HTML value output"
},
{
"name": "entry",
"type": "array",
"description": "The GF entry array"
},
{
"name": "field_settings",
"type": "array",
"description": "Settings for the particular GV field"
},
{
"name": "field",
"type": "array",
"description": "Current field being displayed"
}
],
"categories": [
"entries",
"fields",
"views"
],
"example": "add_filter( 'gravityview_field_entry_value_\\{$field->type\\}', function($output, $entry, $field_settings, $field) {\n // Modify $output as needed\n return $output;\n}, 10, 4 );",
"since": "1.6",
"source": {
"file": "src/Template/TemplateField.php",
"line": 468
},
"url": "/docs/gravityview/filters/gravityview_field_entry_value_field-type/",
"related": []
},
{
"id": "gravityview_field_entry_value_field-type_pre_link",
"name": "gravityview_field_entry_value_\\{$field->type\\}_pre_link",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "output",
"type": "string",
"description": "HTML value output"
},
{
"name": "entry",
"type": "array",
"description": "The GF entry array"
},
{
"name": "field_settings",
"type": "array",
"description": "Settings for the particular GV field"
},
{
"name": "field",
"type": "array",
"description": "Field array, as fetched from GravityView_View::getCurrentField()"
}
],
"categories": [
"entries",
"fields",
"views",
"before"
],
"example": "add_filter( 'gravityview_field_entry_value_\\{$field->type\\}_pre_link', function($output, $entry, $field_settings, $field) {\n // Modify $output as needed\n return $output;\n}, 10, 4 );",
"since": "1.16",
"source": {
"file": "src/Template/TemplateField.php",
"line": 410
},
"url": "/docs/gravityview/filters/gravityview_field_entry_value_field-type_pre_link/",
"related": []
},
{
"id": "gravityview_field_output",
"name": "gravityview_field_output",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "html",
"type": "string",
"description": "Existing HTML output"
},
{
"name": "args",
"type": "array",
"description": "Arguments passed to the function"
},
{
"name": "context",
"type": "\\GV\\Template_Context",
"description": "The context."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview_field_output', function($html, $args, $context) {\n // Modify $html as needed\n return $html;\n}, 10, 3 );",
"since": "2.0",
"source": {
"file": "src/API/class-api.php",
"line": 1161
},
"url": "/docs/gravityview/filters/gravityview_field_output/",
"related": []
},
{
"id": "gravityview_field_support_options",
"name": "gravityview_field_support_options",
"type": "filter",
"product": "gravityview",
"description": "Modify the settings that a field supports.",
"parameters": [
{
"name": "options",
"type": "array",
"description": "Multidimensional array with each key being the input name. Each array setting has type, label, desc and value (default values) keys."
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview_field_support_options', function($options) {\n // Modify $options as needed\n return $options;\n}, 10, 1 );",
"since": "1.0.7-beta",
"source": {
"file": "src/Field/Types/GravityViewField.php",
"line": 579
},
"url": "/docs/gravityview/filters/gravityview_field_support_options/",
"related": []
},
{
"id": "gravityview_field_tick",
"name": "gravityview_field_tick",
"type": "filter",
"product": "gravityview",
"description": "Change the output for a checkbox \"check\" symbol. Default is the \"dashicons-yes\" icon.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "HTML span with dashicons dashicons-yes class"
},
{
"name": "entry",
"type": "array",
"description": "Gravity Forms entry array"
},
{
"name": "field",
"type": "array",
"description": "GravityView field array"
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview_field_tick', function($output, $entry, $field) {\n // Modify $output as needed\n return $output;\n}, 10, 3 );",
"since": null,
"source": {
"file": "templates/deprecated/fields/checkbox.php",
"line": 44
},
"url": "/docs/gravityview/filters/gravityview_field_tick/",
"related": []
},
{
"id": "gravityview_field_visibility_caps",
"name": "gravityview_field_visibility_caps",
"type": "filter",
"product": "gravityview",
"description": "Modify the capabilities shown in the field dropdown.",
"parameters": [
{
"name": "select_cap_choices",
"type": "array",
"description": "Associative array of role slugs with labels ( manage_options => Administrator )"
},
{
"name": "template_id",
"type": "string",
"description": "Optional. View slug"
},
{
"name": "field_id",
"type": "string",
"description": "Optional. GF Field ID - Example: 3, 5.2, entry_link, created_by"
},
{
"name": "context",
"type": "string",
"description": "Optional. What context are we in? Example: single or directory"
},
{
"name": "input_type",
"type": "string",
"description": "Optional. (textarea, list, select, etc.)"
}
],
"categories": [
"fields",
"views"
],
"example": "add_filter( 'gravityview_field_visibility_caps', function($select_cap_choices, $template_id, $field_id, $context, $input_type) {\n // Modify $select_cap_choices as needed\n return $select_cap_choices;\n}, 10, 5 );",
"since": "1.0.1",
"source": {
"file": "src/Admin/Rendering/RenderSettings.php",
"line": 488
},
"url": "/docs/gravityview/filters/gravityview_field_visibility_caps/",
"related": []
},
{
"id": "gravityview_get_entries",
"name": "gravityview_get_entries",
"type": "filter",
"product": "gravityview",
"description": "Filter get entries criteria.",
"parameters": [
{
"name": "parameters",
"type": "array",
"description": "Array with search_criteria, sorting and paging keys."
},
{
"name": "args",
"type": "array",
"description": "View configuration args."
},
{
"name": "id",
"type": "int",
"description": "View id"
},
{
"name": "page_size",
"type": "int",
"description": "Number of entries to show per page"
},
{
"name": "sort_field",
"type": "string",
"description": "Form field id to sort"
},
{
"name": "sort_direction",
"type": "string",
"description": "Sorting direction ('ASC', 'DESC', or 'RAND')"
},
{
"name": "start_date",
"type": "string",
"description": "- Ymd"
},
{
"name": "end_date",
"type": "string",
"description": "- Ymd"
},
{
"name": "class",
"type": "string",
"description": "- assign a html class to the view"
},
{
"name": "offset",
"type": "string",
"description": "(optional) - This is the start point in the current data set (0 index based)."
},
{
"name": "form_id",
"type": "int",
"description": "ID of Gravity Forms form"
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_get_entries', function($parameters, $args, $id, $page_size, $sort_field, $sort_direction, $start_date, $end_date, $class, $offset, $form_id) {\n // Modify $parameters as needed\n return $parameters;\n}, 10, 11 );",
"since": null,
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1468
},
"url": "/docs/gravityview/filters/gravityview_get_entries/",
"related": []
},
{
"id": "gravityview_get_entries_view_id",
"name": "gravityview_get_entries_\\{$view_id\\}",
"type": "filter",
"product": "gravityview",
"description": "Filter get entries criteria for a specific View.",
"parameters": [
{
"name": "parameters",
"type": "array",
"description": "Array with search_criteria, sorting and paging keys."
},
{
"name": "args",
"type": "array",
"description": "View configuration args."
},
{
"name": "form_id",
"type": "int",
"description": "ID of the Gravity Forms form."
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_get_entries_\\{$view_id\\}', function($parameters, $args, $form_id) {\n // Modify $parameters as needed\n return $parameters;\n}, 10, 3 );",
"since": null,
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1477
},
"url": "/docs/gravityview/filters/gravityview_get_entries_view_id/",
"related": []
},
{
"id": "gravityview_get_terms_choices_args",
"name": "gravityview_get_terms_choices_args",
"type": "filter",
"product": "gravityview",
"description": "Modify the arguments passed to `get_terms()`.",
"parameters": [
{
"name": "args",
"type": "array",
"description": "Arguments array as used by the get_terms() function."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_get_terms_choices_args', function($args) {\n // Modify $args as needed\n return $args;\n}, 10, 1 );",
"since": "1.15.3",
"source": {
"file": "src/Utils/helper-functions.php",
"line": 723
},
"url": "/docs/gravityview/filters/gravityview_get_terms_choices_args/",
"related": []
},
{
"id": "gravityview_get_view_entries_.template_slug",
"name": "gravityview_get_view_entries_ . $template_slug",
"type": "filter",
"product": "gravityview",
"description": "Figure out whether to get the entries or not.",
"parameters": [
{
"name": "get_entries",
"type": "bool",
"description": "Whether to get entries. Default: true."
}
],
"categories": [
"entries",
"rendering",
"views"
],
"example": "add_filter( 'gravityview_get_view_entries_ . $template_slug', function($get_entries) {\n // Modify $get_entries as needed\n return $get_entries;\n}, 10, 1 );",
"since": "1.10",
"source": {
"file": "src/Renderer/ViewRenderer.php",
"line": 69
},
"url": "/docs/gravityview/filters/gravityview_get_view_entries_.template_slug/",
"related": []
},
{
"id": "gravityview_go_back_label",
"name": "gravityview_go_back_label",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "label",
"type": "string",
"description": "Existing label text"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_go_back_label', function($label) {\n // Modify $label as needed\n return $label;\n}, 10, 1 );",
"since": "1.0.9",
"source": {
"file": "src/API/class-api.php",
"line": 416
},
"url": "/docs/gravityview/filters/gravityview_go_back_label/",
"related": []
},
{
"id": "gravityview_go_back_url",
"name": "gravityview_go_back_url",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "href",
"type": "string",
"description": "Existing label URL"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_go_back_url', function($href) {\n // Modify $href as needed\n return $href;\n}, 10, 1 );",
"since": "1.17.5",
"source": {
"file": "src/API/class-api.php",
"line": 380
},
"url": "/docs/gravityview/filters/gravityview_go_back_url/",
"related": []
},
{
"id": "gravityview_has_archive",
"name": "gravityview_has_archive",
"type": "filter",
"product": "gravityview",
"description": "Enable Custom Post Type archive?",
"parameters": [
{
"name": "",
"type": "bool",
"description": "False: don't have frontend archive; True: yes, have archive. Default: false"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_has_archive', function($) {\n // Modify $value as needed\n return $value;\n}, 10, 1 );",
"since": "1.7.3",
"source": {
"file": "src/View/View.php",
"line": 342
},
"url": "/docs/gravityview/filters/gravityview_has_archive/",
"related": []
},
{
"id": "gravityview_image_extensions",
"name": "gravityview_image_extensions",
"type": "filter",
"product": "gravityview",
"description": "Filter the image extensions recognized by GravityView.",
"parameters": [
{
"name": "image_exts",
"type": "array",
"description": "Default: ['jpg', 'jpeg', 'jpe', 'gif', 'png', 'bmp', 'tif', 'tiff', 'ico', 'webp', 'svg']."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_image_extensions', function($image_exts) {\n // Modify $image_exts as needed\n return $image_exts;\n}, 10, 1 );",
"since": "1.0-beta",
"source": {
"file": "src/Frontend/Image.php",
"line": 133
},
"url": "/docs/gravityview/filters/gravityview_image_extensions/",
"related": []
},
{
"id": "gravityview_image_html",
"name": "gravityview_image_html",
"type": "filter",
"product": "gravityview",
"description": "Filter the HTML image output.",
"parameters": [
{
"name": "html",
"type": "string",
"description": "The generated image HTML."
},
{
"name": "this",
"type": "\\Image",
"description": "The current image object."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_image_html', function($html, $this) {\n // Modify $html as needed\n return $html;\n}, 10, 2 );",
"since": "1.0-beta",
"source": {
"file": "src/Frontend/Image.php",
"line": 258
},
"url": "/docs/gravityview/filters/gravityview_image_html/",
"related": []
},
{
"id": "gravityview_image_sizes",
"name": "gravityview_image_sizes",
"type": "filter",
"product": "gravityview",
"description": "Modify the image size presets used by GravityView_Image class.",
"parameters": [
{
"name": "image_sizes",
"type": "array",
"description": "Array of image sizes with the key being the size slug, and the value being an array with width and height defined, in pixels."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_image_sizes', function($image_sizes) {\n // Modify $image_sizes as needed\n return $image_sizes;\n}, 10, 1 );",
"since": "1.0-beta",
"source": {
"file": "src/Frontend/Image.php",
"line": 173
},
"url": "/docs/gravityview/filters/gravityview_image_sizes/",
"related": []
},
{
"id": "gravityview_is_admin_page",
"name": "gravityview_is_admin_page",
"type": "filter",
"product": "gravityview",
"description": "Is the current admin page a GravityView-related page?",
"parameters": [
{
"name": "is_page",
"type": "string\\",
"description": "bool`"
},
{
"name": "hook",
"type": "string",
"description": "The name of the page to check against. Is passed to the method."
}
],
"categories": [
"views",
"admin"
],
"example": "add_filter( 'gravityview_is_admin_page', function($is_page, $hook) {\n // Modify $is_page as needed\n return $is_page;\n}, 10, 2 );",
"since": "2.0",
"source": {
"file": "src/Request/AdminRequest.php",
"line": 74
},
"url": "/docs/gravityview/filters/gravityview_is_admin_page/",
"related": []
},
{
"id": "gravityview_is_edit_entry",
"name": "gravityview_is_edit_entry",
"type": "filter",
"product": "gravityview",
"description": "Checks whether we're currently on the Edit Entry screen.",
"parameters": [
{
"name": "is_edit_entry",
"type": "bool",
"description": "Whether the current request is an Edit Entry request. Default: false."
}
],
"categories": [
"entries",
"editing",
"views"
],
"example": "add_filter( 'gravityview_is_edit_entry', function($is_edit_entry) {\n // Modify $is_edit_entry as needed\n return $is_edit_entry;\n}, 10, 1 );",
"since": "2.0-beta.2",
"source": {
"file": "src/Request/Request.php",
"line": 315
},
"url": "/docs/gravityview/filters/gravityview_is_edit_entry/",
"related": []
},
{
"id": "gravityview_is_hierarchical",
"name": "gravityview_is_hierarchical",
"type": "filter",
"product": "gravityview",
"description": "Make GravityView Views hierarchical by returning TRUE.",
"parameters": [
{
"name": "is_hierarchical",
"type": "bool",
"description": "Default: false"
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_is_hierarchical', function($is_hierarchical) {\n // Modify $is_hierarchical as needed\n return $is_hierarchical;\n}, 10, 1 );",
"since": "1.13",
"source": {
"file": "src/View/View.php",
"line": 271
},
"url": "/docs/gravityview/filters/gravityview_is_hierarchical/",
"related": []
},
{
"id": "gravityview_js_localization",
"name": "gravityview_js_localization",
"type": "filter",
"product": "gravityview",
"description": "Modify the gvGlobals data used by front-end scripts.",
"parameters": [
{
"name": "js_localization",
"type": "array",
"description": "The data passed to the Javascript file."
},
{
"name": "views",
"type": "array",
"description": "Array of View data arrays with View settings."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_js_localization', function($js_localization, $views) {\n // Modify $js_localization as needed\n return $js_localization;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/Shortcode/ShortcodeRenderer.php",
"line": 762
},
"url": "/docs/gravityview/filters/gravityview_js_localization/",
"related": []
},
{
"id": "gravityview_lightbox_script",
"name": "gravityview_lightbox_script",
"type": "filter",
"product": "gravityview",
"description": "Modify the CSS class used to trigger lightbox functionality.",
"parameters": [
{
"name": "class",
"type": "string",
"description": "The CSS class to trigger lightbox. Default: 'thickbox'."
}
],
"categories": [
"views",
"assets"
],
"example": "add_filter( 'gravityview_lightbox_script', function($class) {\n // Modify $class as needed\n return $class;\n}, 10, 1 );",
"since": "1.0.5-beta",
"source": {
"file": "templates/fields/field-post_image-html.php",
"line": 90
},
"url": "/docs/gravityview/filters/gravityview_lightbox_script/",
"related": []
},
{
"id": "gravityview_lightbox_style",
"name": "gravityview_lightbox_style",
"type": "filter",
"product": "gravityview",
"description": "Override the lightbox style to enqueue. Default: `thickbox`.",
"parameters": [
{
"name": "style_slug",
"type": "string",
"description": "If you want to use a different lightbox style, return the name of it here."
},
{
"name": "view",
"type": "\\GV\\View",
"description": "The View."
}
],
"categories": [
"views",
"assets"
],
"example": "add_filter( 'gravityview_lightbox_style', function($style_slug, $view) {\n // Modify $style_slug as needed\n return $style_slug;\n}, 10, 2 );",
"since": "2.5.1",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1864
},
"url": "/docs/gravityview/filters/gravityview_lightbox_style/",
"related": []
},
{
"id": "gravityview_map_link",
"name": "gravityview_map_link",
"type": "filter",
"product": "gravityview",
"description": "Modify the map link generated. You can use a different mapping service, for example.",
"parameters": [
{
"name": "link",
"type": "string",
"description": "Map link"
},
{
"name": "address",
"type": "string",
"description": "Address to generate link for"
},
{
"name": "url",
"type": "string",
"description": "URL generated by the function"
}
],
"categories": [
"views",
"maps"
],
"example": "add_filter( 'gravityview_map_link', function($link, $address, $url) {\n // Modify $link as needed\n return $link;\n}, 10, 3 );",
"since": null,
"source": {
"file": "src/API/class-api.php",
"line": 931
},
"url": "/docs/gravityview/filters/gravityview_map_link/",
"related": []
},
{
"id": "gravityview_noconflict_type",
"name": "gravityview_noconflict_\\{$type\\}",
"type": "filter",
"product": "gravityview",
"description": "Modify the list of no conflict scripts or styles.",
"parameters": [
{
"name": "required_objects",
"type": "array",
"description": "Array of registered script/style handles to allow."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_noconflict_\\{$type\\}', function($required_objects) {\n // Modify $required_objects as needed\n return $required_objects;\n}, 10, 1 );",
"since": "1.0-beta",
"source": {
"file": "src/Admin/NoConflict.php",
"line": 204
},
"url": "/docs/gravityview/filters/gravityview_noconflict_type/",
"related": []
},
{
"id": "gravityview_page_links_args",
"name": "gravityview_page_links_args",
"type": "filter",
"product": "gravityview",
"description": "Filters the pagination options before they are passed to `paginate_links()`.",
"parameters": [
{
"name": "page_link_args",
"type": "array",
"description": "Array of arguments for the paginate_links() function. Read more about paginate_links()."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_page_links_args', function($page_link_args) {\n // Modify $page_link_args as needed\n return $page_link_args;\n}, 10, 1 );",
"since": "1.1.4",
"source": {
"file": "src/Widget/Types/PageLinks.php",
"line": 209
},
"url": "/docs/gravityview/filters/gravityview_page_links_args/",
"related": []
},
{
"id": "gravityview_pagination_counts",
"name": "gravityview_pagination_counts",
"type": "filter",
"product": "gravityview",
"description": "Modify the displayed pagination numbers.",
"parameters": [
{
"name": "counts",
"type": "array",
"description": "Array with $first, $last, $total numbers in that order."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_pagination_counts', function($counts) {\n // Modify $counts as needed\n return $counts;\n}, 10, 1 );",
"since": "1.13",
"source": {
"file": "src/View/ViewLegacy.php",
"line": 535
},
"url": "/docs/gravityview/filters/gravityview_pagination_counts/",
"related": []
},
{
"id": "gravityview_pagination_output",
"name": "gravityview_pagination_output",
"type": "filter",
"product": "gravityview",
"description": "Modify the pagination widget output.",
"parameters": [
{
"name": "output",
"type": "string",
"description": "HTML output."
},
{
"name": "first",
"type": "int",
"description": "First entry number."
},
{
"name": "last",
"type": "int",
"description": "Last entry number."
},
{
"name": "total",
"type": "int",
"description": "Total entries count."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_pagination_output', function($output, $first, $last, $total) {\n // Modify $output as needed\n return $output;\n}, 10, 4 );",
"since": "1.13.1",
"source": {
"file": "src/Widget/Types/PaginationInfo.php",
"line": 86
},
"url": "/docs/gravityview/filters/gravityview_pagination_output/",
"related": []
},
{
"id": "gravityview_post_image_meta",
"name": "gravityview_post_image_meta",
"type": "filter",
"product": "gravityview",
"description": "Modify the values used for the image meta.",
"parameters": [
{
"name": "image_meta",
"type": "array",
"description": "Associative array with title, caption, and description keys, each an array with label, value, tag_label and tag_value keys"
}
],
"categories": [
"views",
"after"
],
"example": "add_filter( 'gravityview_post_image_meta', function($image_meta) {\n // Modify $image_meta as needed\n return $image_meta;\n}, 10, 1 );",
"since": null,
"source": {
"file": "templates/deprecated/fields/post_image.php",
"line": 107
},
"url": "/docs/gravityview/filters/gravityview_post_image_meta/",
"related": []
},
{
"id": "gravityview_post_image_meta_show_labels",
"name": "gravityview_post_image_meta_show_labels",
"type": "filter",
"product": "gravityview",
"description": "Whether to show labels for the image meta.",
"parameters": [
{
"name": "showlabels",
"type": "bool",
"description": "True: Show labels; False: hide labels"
}
],
"categories": [
"views",
"after"
],
"example": "add_filter( 'gravityview_post_image_meta_show_labels', function($showlabels) {\n // Modify $showlabels as needed\n return $showlabels;\n}, 10, 1 );",
"since": null,
"source": {
"file": "templates/deprecated/fields/post_image.php",
"line": 140
},
"url": "/docs/gravityview/filters/gravityview_post_image_meta_show_labels/",
"related": []
},
{
"id": "gravityview_post_type_support",
"name": "gravityview_post_type_support",
"type": "filter",
"product": "gravityview",
"description": "Filters the supports value.",
"parameters": [
{
"name": "supports",
"type": "array",
"description": "Array of features associated with a functional area of the edit screen. Default: 'title', 'revisions'. If $is_hierarchical, also 'page-attributes'"
},
{
"name": "is_hierarchical",
"type": "bool",
"description": "Do Views support parent/child relationships? See gravityview_is_hierarchical filter."
}
],
"categories": [
"views",
"after"
],
"example": "add_filter( 'gravityview_post_type_support', function($supports, $is_hierarchical) {\n // Modify $supports as needed\n return $supports;\n}, 10, 2 );",
"since": "1.15.2",
"source": {
"file": "src/View/View.php",
"line": 286
},
"url": "/docs/gravityview/filters/gravityview_post_type_support/",
"related": []
},
{
"id": "gravityview_register_directory_template",
"name": "gravityview_register_directory_template",
"type": "filter",
"product": "gravityview",
"description": "Fetch available View templates.",
"parameters": [
{
"name": "templates",
"type": "array",
"description": "Templates to show."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview_register_directory_template', function($templates) {\n // Modify $templates as needed\n return $templates;\n}, 10, 1 );",
"since": "1.14",
"source": {
"file": "src/Utils/connector-functions.php",
"line": 344
},
"url": "/docs/gravityview/filters/gravityview_register_directory_template/",
"related": []
},
{
"id": "gravityview_register_directory_widgets",
"name": "gravityview_register_directory_widgets",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "registered_widgets",
"type": "array",
"description": "Empty array"
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview_register_directory_widgets', function($registered_widgets) {\n // Modify $registered_widgets as needed\n return $registered_widgets;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/Widget/Widget.php",
"line": 598
},
"url": "/docs/gravityview/filters/gravityview_register_directory_widgets/",
"related": []
},
{
"id": "gravityview_render_after_label",
"name": "gravityview_render_after_label",
"type": "filter",
"product": "gravityview",
"description": "Append content to a field label.",
"parameters": [
{
"name": "appended_content",
"type": "string",
"description": "Content you can add after a label. Empty by default."
},
{
"name": "field",
"type": "array",
"description": "GravityView field array"
}
],
"categories": [
"rendering",
"views",
"after"
],
"example": "add_filter( 'gravityview_render_after_label', function($appended_content, $field) {\n // Modify $appended_content as needed\n return $appended_content;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/GravityForms/QueryExtensions/_mocks.php",
"line": 271
},
"url": "/docs/gravityview/filters/gravityview_render_after_label/",
"related": []
},
{
"id": "gravityview_search_class",
"name": "gravityview_search_class",
"type": "filter",
"product": "gravityview",
"description": "Modify the CSS class for the search form.",
"parameters": [
{
"name": "search_class",
"type": "string",
"description": "The CSS class for the search form"
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview_search_class', function($search_class) {\n // Modify $search_class as needed\n return $search_class;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/Widget/Types/SearchWidget.php",
"line": 1121
},
"url": "/docs/gravityview/filters/gravityview_search_class/",
"related": []
},
{
"id": "gravityview_search_criteria",
"name": "gravityview_search_criteria",
"type": "filter",
"product": "gravityview",
"description": "Compatibility with filters hooking in `gravityview_search_criteria` instead of `gravityview_fe_search_criteria`.",
"parameters": [],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview_search_criteria', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1259
},
"url": "/docs/gravityview/filters/gravityview_search_criteria/",
"related": []
},
{
"id": "gravityview_search_datepicker_class",
"name": "gravityview_search_datepicker_class",
"type": "filter",
"product": "gravityview",
"description": "Filters the css class value.",
"parameters": [
{
"name": "css_class",
"type": "string",
"description": "CSS class to use. Default: gv-datepicker datepicker mdy \\n Options are:
mdy (mm/dd/yyyy)dmy (dd/mm/yyyy)dmy_dash (dd-mm-yyyy)dmy_dot (dd.mm.yyyy)ymd_slash (yyyy/mm/dd)ymd_dash (yyyy-mm-dd)ymd_dot (yyyy.mm.dd)
"
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview_search_datepicker_class', function($css_class) {\n // Modify $css_class as needed\n return $css_class;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/Widget/Types/SearchWidget.php",
"line": 1394
},
"url": "/docs/gravityview/filters/gravityview_search_datepicker_class/",
"related": []
},
{
"id": "gravityview_search_field_label",
"name": "gravityview_search_field_label",
"type": "filter",
"product": "gravityview",
"description": "Modify the label for a search field. Supports returning HTML.",
"parameters": [
{
"name": "label",
"type": "string",
"description": "Existing label text, sanitized."
},
{
"name": "form_field",
"type": "array",
"description": "Gravity Forms field array, as returned by GFFormsModel::get_field()"
},
{
"name": "field",
"type": "array",
"description": "Field setting as sent by the GV configuration - has field, input (input type), and label keys"
}
],
"categories": [
"fields",
"search",
"views"
],
"example": "add_filter( 'gravityview_search_field_label', function($label, $form_field, $field) {\n // Modify $label as needed\n return $label;\n}, 10, 3 );",
"since": "1.17.3: Added $field parameter",
"source": {
"file": "src/Search/Fields/SearchField.php",
"line": 654
},
"url": "/docs/gravityview/filters/gravityview_search_field_label/",
"related": []
},
{
"id": "gravityview_search_operator",
"name": "gravityview_search_operator",
"type": "filter",
"product": "gravityview",
"description": "Modify the search operator for the field (contains, is, isnot, etc).",
"parameters": [
{
"name": "operator",
"type": "string",
"description": "Existing search operator."
},
{
"name": "filter",
"type": "array",
"description": "Array with key, value, operator, type keys."
}
],
"categories": [
"search",
"views"
],
"example": "add_filter( 'gravityview_search_operator', function($operator, $filter) {\n // Modify $operator as needed\n return $operator;\n}, 10, 2 );",
"since": "1.1",
"source": {
"file": "src/Legacy/Utility/Common.php",
"line": 699
},
"url": "/docs/gravityview/filters/gravityview_search_operator/",
"related": []
},
{
"id": "gravityview_slug",
"name": "gravityview_slug",
"type": "filter",
"product": "gravityview",
"description": "Modify the url part for a View.",
"parameters": [
{
"name": "slug",
"type": "string",
"description": "The slug shown in the URL."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_slug', function($slug) {\n // Modify $slug as needed\n return $slug;\n}, 10, 1 );",
"since": "1.0",
"source": {
"file": "src/View/View.php",
"line": 354
},
"url": "/docs/gravityview/filters/gravityview_slug/",
"related": []
},
{
"id": "gravityview_status",
"name": "gravityview_status",
"type": "filter",
"product": "gravityview",
"description": "Modify entry status requirements to be included in search results.",
"parameters": [
{
"name": "status",
"type": "string",
"description": "Default: active. Accepts all Gravity Forms entry statuses, including spam and trash"
},
{
"name": "args",
"type": "array",
"description": "View configuration arguments."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_status', function($status, $args) {\n // Modify $status as needed\n return $status;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1330
},
"url": "/docs/gravityview/filters/gravityview_status/",
"related": []
},
{
"id": "gravityview_table_cells",
"name": "gravityview_table_cells",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "fields",
"type": "array",
"description": "Array of field configurations."
},
{
"name": "this",
"type": "\\ViewLegacy",
"description": "The current View object."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_table_cells', function($fields, $this) {\n // Modify $fields as needed\n return $fields;\n}, 10, 2 );",
"since": "2.0.6.1",
"source": {
"file": "src/View/ViewLegacy.php",
"line": 718
},
"url": "/docs/gravityview/filters/gravityview_table_cells/",
"related": [
"gravityview_table_cells_after",
"gravityview_table_cells_before"
]
},
{
"id": "gravityview_template_active_areas",
"name": "gravityview_template_active_areas",
"type": "filter",
"product": "gravityview",
"description": "Filters the active areas for the View template.",
"parameters": [
{
"name": "template_areas",
"type": "array",
"description": "Empty array, to be filled in by the template class."
},
{
"name": "template_id",
"type": "string",
"description": "Template ID, like default_list, default_table, preset_business_data, etc. [`\\GravityView_Template::__construct()`](../../api/classes/gravityview_template)"
},
{
"name": "context",
"type": "string",
"description": "Current View context: directory, single, edit, or search (default: 'single')."
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview_template_active_areas', function($template_areas, $template_id, $context) {\n // Modify $template_areas as needed\n return $template_areas;\n}, 10, 3 );",
"since": "1.0-beta",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 2184
},
"url": "/docs/gravityview/filters/gravityview_template_active_areas/",
"related": []
},
{
"id": "gravityview_template_field_type_options",
"name": "gravityview_template_\\{$field_type\\}_options",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "field_options",
"type": "array",
"description": "Array of field options with label, value, type, default keys."
},
{
"name": "template_id",
"type": "string",
"description": "Table slug."
},
{
"name": "field_id",
"type": "float",
"description": "GF Field ID - Example: 3, 5.2, entry_link, created_by."
},
{
"name": "context",
"type": "string",
"description": "What context are we in? Example: single or directory."
},
{
"name": "input_type",
"type": "string",
"description": "(textarea, list, select, etc.)."
},
{
"name": "form_id",
"type": "int",
"description": "The form ID. \\{@since 2.5\\}"
}
],
"categories": [
"fields",
"rendering",
"views"
],
"example": "add_filter( 'gravityview_template_\\{$field_type\\}_options', function($field_options, $template_id, $field_id, $context, $input_type, $form_id) {\n // Modify $field_options as needed\n return $field_options;\n}, 10, 6 );",
"since": null,
"source": {
"file": "src/Admin/Rendering/RenderSettings.php",
"line": 327
},
"url": "/docs/gravityview/filters/gravityview_template_field_type_options/",
"related": []
},
{
"id": "gravityview_template_input_type_options",
"name": "gravityview_template_\\{$input_type\\}_options",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "field_options",
"type": "array",
"description": "Array of field options with label, value, type, default keys."
},
{
"name": "template_id",
"type": "string",
"description": "Table slug."
},
{
"name": "field_id",
"type": "float",
"description": "GF Field ID - Example: 3, 5.2, entry_link, created_by."
},
{
"name": "context",
"type": "string",
"description": "What context are we in? Example: single or directory."
},
{
"name": "input_type",
"type": "string",
"description": "(textarea, list, select, etc.)."
},
{
"name": "form_id",
"type": "int",
"description": "The form ID. \\{@since 2.5\\}"
}
],
"categories": [
"rendering",
"views"
],
"example": "add_filter( 'gravityview_template_\\{$input_type\\}_options', function($field_options, $template_id, $field_id, $context, $input_type, $form_id) {\n // Modify $field_options as needed\n return $field_options;\n}, 10, 6 );",
"since": null,
"source": {
"file": "src/Admin/Rendering/RenderSettings.php",
"line": 341
},
"url": "/docs/gravityview/filters/gravityview_template_input_type_options/",
"related": []
},
{
"id": "gravityview_tooltips",
"name": "gravityview_tooltips",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "gv_tooltips",
"type": "array",
"description": "Associative array with unique keys containing array of title and value keys, as expected by gform_tooltips filter."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_tooltips', function($gv_tooltips) {\n // Modify $gv_tooltips as needed\n return $gv_tooltips;\n}, 10, 1 );",
"since": "1.0.9-beta",
"source": {
"file": "src/Admin/AdminViews.php",
"line": 605
},
"url": "/docs/gravityview/filters/gravityview_tooltips/",
"related": []
},
{
"id": "gravityview_use_cache",
"name": "gravityview_use_cache",
"type": "filter",
"product": "gravityview",
"description": "Modify whether to use the cache or not.",
"parameters": [
{
"name": "use_cache",
"type": "bool",
"description": "Previous setting."
},
{
"name": "this",
"type": "\\Cache",
"description": "The GravityView_Cache object."
}
],
"categories": [
"views",
"caching"
],
"example": "add_filter( 'gravityview_use_cache', function($use_cache, $this) {\n // Modify $use_cache as needed\n return $use_cache;\n}, 10, 2 );",
"since": "1.3",
"source": {
"file": "src/Data/Cache.php",
"line": 808
},
"url": "/docs/gravityview/filters/gravityview_use_cache/",
"related": []
},
{
"id": "gravityview_use_legacy_search_style",
"name": "gravityview_use_legacy_search_style",
"type": "filter",
"product": "gravityview",
"description": "Should GravityView use the legacy Search Bar stylesheet (from before Version 1.17)?",
"parameters": [
{
"name": "use_legacy_search_style",
"type": "bool",
"description": "If true, loads gv-legacy-search(-rtl).css. If false, loads gv-default-styles(-rtl).css. -rtl is added on RTL websites. Default: false"
}
],
"categories": [
"search",
"views",
"assets"
],
"example": "add_filter( 'gravityview_use_legacy_search_style', function($use_legacy_search_style) {\n // Modify $use_legacy_search_style as needed\n return $use_legacy_search_style;\n}, 10, 1 );",
"since": "1.17",
"source": {
"file": "src/Frontend/Frontend.php",
"line": 2062
},
"url": "/docs/gravityview/filters/gravityview_use_legacy_search_style/",
"related": []
},
{
"id": "gravityview_video_settings",
"name": "gravityview_video_settings",
"type": "filter",
"product": "gravityview",
"description": "Modify the default attributes that will be passed to the wp_video_shortcode() function.",
"parameters": [
{
"name": "video_settings",
"type": "array",
"description": "Array with src and class keys."
},
{
"name": "context",
"type": "\\Template_Context",
"description": "The context."
}
],
"categories": [
"views"
],
"example": "add_filter( 'gravityview_video_settings', function($video_settings, $context) {\n // Modify $video_settings as needed\n return $video_settings;\n}, 10, 2 );",
"since": "1.2",
"source": {
"file": "src/Field/Types/FileUpload.php",
"line": 380
},
"url": "/docs/gravityview/filters/gravityview_video_settings/",
"related": []
},
{
"id": "gravityview_view_entries",
"name": "gravityview_view_entries",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "entries",
"type": "array",
"description": "Array of entries to be displayed"
},
{
"name": "args",
"type": "array",
"description": "View settings associative array"
}
],
"categories": [
"entries",
"views"
],
"example": "add_filter( 'gravityview_view_entries', function($entries, $args) {\n // Modify $entries as needed\n return $entries;\n}, 10, 2 );",
"since": null,
"source": {
"file": "src/Frontend/Frontend.php",
"line": 1389
},
"url": "/docs/gravityview/filters/gravityview_view_entries/",
"related": []
},
{
"id": "gravityview_widget_active_areas",
"name": "gravityview_widget_active_areas",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [
{
"name": "default_areas",
"type": "array",
"description": "Definition for default widget areas"
}
],
"categories": [
"views",
"widgets"
],
"example": "add_filter( 'gravityview_widget_active_areas', function($default_areas) {\n // Modify $default_areas as needed\n return $default_areas;\n}, 10, 1 );",
"since": null,
"source": {
"file": "src/Widget/Widget.php",
"line": 270
},
"url": "/docs/gravityview/filters/gravityview_widget_active_areas/",
"related": []
},
{
"id": "gravityview_widget_search_filters",
"name": "gravityview_widget_search_filters",
"type": "filter",
"product": "gravityview",
"description": "Modify what fields are shown. The order of the fields in the $search_filters array controls the order as displayed in the search bar widget.",
"parameters": [
{
"name": "search_fields",
"type": "array",
"description": "Array of search filters with key, label, value, type, choices keys"
},
{
"name": "widget",
"type": "\\GravityView_Widget_Search",
"description": "Current widget object"
},
{
"name": "widget_args",
"type": "array\\",
"description": "null`"
},
{
"name": "context",
"type": "null\\",
"description": "string\\"
},
{
"name": "position",
"type": "string\\",
"description": "null`"
}
],
"categories": [
"search",
"views",
"widgets"
],
"example": "add_filter( 'gravityview_widget_search_filters', function($search_fields, $widget, $widget_args, $context, $position) {\n // Modify $search_fields as needed\n return $search_fields;\n}, 10, 5 );",
"since": null,
"source": {
"file": "src/Search/SearchFieldCollection.php",
"line": 667
},
"url": "/docs/gravityview/filters/gravityview_widget_search_filters/",
"related": []
},
{
"id": "hook",
"name": "$hook",
"type": "filter",
"product": "gravityview",
"description": ":::warning[Deprecated]",
"parameters": [],
"categories": [
"general"
],
"example": "add_filter( '$hook', function() {\n // Modify $value as needed\n return $value;\n} );",
"since": null,
"source": {
"file": "src/Deprecation/DeprecatedHookNotices.php",
"line": 117
},
"url": "/docs/gravityview/filters/hook/",
"related": []
},
{
"id": "selfSCAN_FILTER",
"name": "self::SCAN_FILTER",
"type": "filter",
"product": "gravityview",
"description": "Filters whether a post's surrounding block template and its parts are scanned for embedded Views.",
"parameters": [
{
"name": "scan",
"type": "bool",
"description": "Whether to scan. Default: whether the active theme is a block theme."
},
{
"name": "post",
"type": "[\\WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)",
"description": "The post being rendered."
}
],
"categories": [
"search"
],
"example": "add_filter( 'self::SCAN_FILTER', function($scan, $post) {\n // Modify $scan as needed\n return $scan;\n}, 10, 2 );",
"since": "3.5.0",
"source": {
"file": "src/View/BlockTemplateEmbeds.php",
"line": 80
},
"url": "/docs/gravityview/filters/selfSCAN_FILTER/",
"related": []
},
{
"id": "this-filter_prefix._get_template_part",
"name": "$this->filter_prefix . _get_template_part",
"type": "filter",
"product": "gravityview",
"description": "Allow template choices to be filtered.",
"parameters": [
{
"name": "templates",
"type": "array",
"description": "Names of template files that should be looked for, for given slug and name."
},
{
"name": "slug",
"type": "string",
"description": "Template slug."
},
{
"name": "name",
"type": "string",
"description": "Template variation name."
}
],
"categories": [
"search",
"rendering"
],
"example": "add_filter( '$this->filter_prefix . _get_template_part', function($templates, $slug, $name) {\n // Modify $templates as needed\n return $templates;\n}, 10, 3 );",
"since": "1.0.0",
"source": {
"file": "src/Template/GamajoTemplateLoader.php",
"line": 204
},
"url": "/docs/gravityview/filters/this-filter_prefix._get_template_part/",
"related": []
},
{
"id": "this-filter_prefix._template_paths",
"name": "$this->filter_prefix . _template_paths",
"type": "filter",
"product": "gravityview",
"description": "Allow ordered list of template paths to be amended.",
"parameters": [
{
"name": "file_paths",
"type": "array",
"description": "Default is directory in child theme at index 1, parent theme at 10, and plugin at 100."
}
],
"categories": [
"search",
"rendering"
],
"example": "add_filter( '$this->filter_prefix . _template_paths', function($file_paths) {\n // Modify $file_paths as needed\n return $file_paths;\n}, 10, 1 );",
"since": "1.0.0",
"source": {
"file": "src/Template/GamajoTemplateLoader.php",
"line": 304
},
"url": "/docs/gravityview/filters/this-filter_prefix._template_paths/",
"related": []
}
],
"stats": {
"total": 638,
"actions": 121,
"filters": 517
}
}