{ "generated": "2026-05-17T00:45:48.035Z", "product": { "id": "gravityflow", "label": "Gravity Flow", "repo": "gravityforms/gravityflow", "actions": [ "gform_after_update_entry", "gravityflow_below_status_list_user_input", "gravityflow_below_workflow_info_entry_detail", "gravityflow_enqueue_admin_scripts", "gravityflow_enqueue_frontend_scripts", "gravityflow_entry_detail_content_after", "gravityflow_entry_detail_content_before", "gravityflow_post_update_post", "gravityflow_pre_cancel_workflow", "gravityflow_pre_restart_workflow", "gravityflow_step_complete", "gravityflow_step_start", "post_edd_sl_plugin_updater_setup" ], "filters": [ "gform_order_label", "gform_order_summary", "gform_pre_validation", "gravityflow_admin_action_feedback", "gravityflow_admin_actions_workflow_detail", "gravityflow_approval_assignee_status_feedback", "gravityflow_approval_assignee_status_types", "gravityflow_approval_confirm_prompt_messages", "gravityflow_approval_note_label_workflow_detail", "gravityflow_approval_revert_step_id", "gravityflow_approve_label_workflow_detail", "gravityflow_assignee_choices", "gravityflow_assignee_email_reminder_repeat_days", "gravityflow_assignee_status_list_user_input", "gravityflow_assignee_status_workflow_detail", "gravityflow_back_link_url_entry_detail", "gravityflow_bulk_action_status_table", "gravityflow_can_render_form", "gravityflow_columns_inbox_table", "gravityflow_columns_status_table", "gravityflow_complete_label_user_input", "gravityflow_date_format_current_step_merge_tag", "gravityflow_date_format_entry_detail", "gravityflow_discussion_items_display_limit", "gravityflow_discussion_items_display_toggle", "gravityflow_display_name_discussion_field", "gravityflow_editable_fields", "gravityflow_entry_detail_args", "gravityflow_entry_link_inbox_table", "gravityflow_entry_\\{$this->get_type()\\}_response_mapping", "gravityflow_entry_url_inbox_table", "gravityflow_entry_url_status_table", "gravityflow_event_limit_activity_page", "gravityflow_feed_condition_entry_properties", "gravityflow_feedback_approval", "gravityflow_feedback_approval_token", "gravityflow_feedback_cancel_workflow", "gravityflow_feedback_message_user_input", "gravityflow_field_filters_status_table", "gravityflow_field_value_status_table", "gravityflow_form_ids_inbox", "gravityflow_form_ids_status", "gravityflow_in_progress_label_user_input", "gravityflow_inbox_args", "gravityflow_inbox_field_value", "gravityflow_inbox_items_per_page_default", "gravityflow_inbox_paging", "gravityflow_inbox_search_criteria", "gravityflow_inbox_sorting", "gravityflow_inbox_submitter_name", "gravityflow_is_delayed_pre_process_workflow", "gravityflow_js_config_admin", "gravityflow_js_config_shared", "gravityflow_js_config_theme", "gravityflow_major_version_auto_updates_allowed", "gravityflow_network_non_site_user_notification", "gravityflow_next_step", "gravityflow_note_valid", "gravityflow_page_load_logic_setting", "gravityflow_permission_denied_message_entry_detail", "gravityflow_permission_granted_entry_detail", "gravityflow_print_styles", "gravityflow_reject_label_workflow_detail", "gravityflow_reports_args", "gravityflow_response_message_webhook", "gravityflow_rest_api_capability_cancel_workflow", "gravityflow_rest_api_capability_get_forms_steps", "gravityflow_rest_api_capability_process_step", "gravityflow_rest_api_capability_reports", "gravityflow_rest_api_capability_restart_step", "gravityflow_rest_api_capability_restart_workflow", "gravityflow_rest_api_capability_send_step", "gravityflow_rest_api_capability_workflow_status", "gravityflow_reverse_comment_order_discussion_field", "gravityflow_revert_label_workflow_detail", "gravityflow_sanitize_instructions", "gravityflow_save_progress_button_text_user_input", "gravityflow_save_progress_button_user_input", "gravityflow_search_criteria_status", "gravityflow_send_to_step_condition_met_required", "gravityflow_send_to_step_condition_not_met", "gravityflow_shortcode_ . $a[page]", "gravityflow_site_cookie_path", "gravityflow_sort_columns_status_table", "gravityflow_sort_criteria_status", "gravityflow_status_args", "gravityflow_status_submitter_name", "gravityflow_step_assignees", "gravityflow_step_column_status_page", "gravityflow_step_due_date_timestamp", "gravityflow_step_expiration_timestamp", "gravityflow_step_highlight_color_inbox", "gravityflow_step_is_condition_met", "gravityflow_step_notification_assignees", "gravityflow_step_schedule_timestamp", "gravityflow_step_settings_fields", "gravityflow_step_status_evaluation_approval", "gravityflow_step_status_webhook", "gravityflow_submit_button_text_user_input", "gravityflow_submit_button_user_input", "gravityflow_\\{$this->get_type()\\}_form", "gravityflow_timeline_notes", "gravityflow_timeline_step_icon", "gravityflow_update_button_text_user_input", "gravityflow_update_button_user_input", "gravityflow_user_input_by_view_edit", "gravityflow_webhook_url_in_note", "gravityflow_workflow_url" ] }, "hooks": [ { "id": "gform_after_update_entry", "name": "gform_after_update_entry", "type": "action", "product": "gravityflow", "description": ":::info[Dynamic Hook Name]", "parameters": [ { "name": "form", "type": "array", "description": "The form object for the entry." }, { "name": "entry_id", "type": "int", "description": "The entry ID." }, { "name": "original_entry", "type": "array", "description": "The entry object before being updated." } ], "categories": [ "entries", "forms", "after" ], "example": "add_action( 'gform_after_update_entry', function($form, $entry_id, $original_entry) {\n // Your code here\n}, 10, 3 );", "since": "unknown: unknown", "source": { "file": "includes/steps/traits/trait-editable-fields.php", "line": 510 }, "url": "/docs/gravityflow/actions/gform_after_update_entry/", "related": [] }, { "id": "gravityflow_below_status_list_user_input", "name": "gravityflow_below_status_list_user_input", "type": "action", "product": "gravityflow", "description": "Allows content to be added in the workflow box below the status list.", "parameters": [ { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." }, { "name": "form", "type": "array", "description": "The current form." } ], "categories": [ "general" ], "example": "add_action( 'gravityflow_below_status_list_user_input', function($this, $form) {\n // Your code here\n}, 10, 2 );", "since": null, "source": { "file": "includes/steps/class-step-user-input.php", "line": 566 }, "url": "/docs/gravityflow/actions/gravityflow_below_status_list_user_input/", "related": [] }, { "id": "gravityflow_below_workflow_info_entry_detail", "name": "gravityflow_below_workflow_info_entry_detail", "type": "action", "product": "gravityflow", "description": "Allows content to be added in the workflow box below the workflow status info.", "parameters": [ { "name": "form", "type": "array", "description": "The form which created this entry." }, { "name": "entry", "type": "array", "description": "The entry currently being displayed." }, { "name": "current_step", "type": "\\Gravity_Flow_Step", "description": "The current step for this entry." } ], "categories": [ "entries" ], "example": "add_action( 'gravityflow_below_workflow_info_entry_detail', function($form, $entry, $current_step) {\n // Your code here\n}, 10, 3 );", "since": null, "source": { "file": "class-gravity-flow.php", "line": 3833 }, "url": "/docs/gravityflow/actions/gravityflow_below_workflow_info_entry_detail/", "related": [] }, { "id": "gravityflow_enqueue_admin_scripts", "name": "gravityflow_enqueue_admin_scripts", "type": "action", "product": "gravityflow", "description": "Allows additional scripts to be enqueued when others are loaded in the admin.", "parameters": [], "categories": [ "admin", "assets" ], "example": "add_action( 'gravityflow_enqueue_admin_scripts', function() {\n // Your code here\n} );", "since": "[2.8.1](../../since/2-8-1/)", "source": { "file": "class-gravity-flow.php", "line": 6914 }, "url": "/docs/gravityflow/actions/gravityflow_enqueue_admin_scripts/", "related": [] }, { "id": "gravityflow_enqueue_frontend_scripts", "name": "gravityflow_enqueue_frontend_scripts", "type": "action", "product": "gravityflow", "description": "Allows additional scripts to be enqueued when the gravityflow shortcode is present on the page.", "parameters": [], "categories": [ "frontend", "assets" ], "example": "add_action( 'gravityflow_enqueue_frontend_scripts', function() {\n // Your code here\n} );", "since": null, "source": { "file": "class-gravity-flow.php", "line": 1103 }, "url": "/docs/gravityflow/actions/gravityflow_enqueue_frontend_scripts/", "related": [] }, { "id": "gravityflow_entry_detail_content_after", "name": "gravityflow_entry_detail_content_after", "type": "action", "product": "gravityflow", "description": "Allows customized markup to be included after the entry details grid.", "parameters": [ { "name": "form", "type": "array", "description": "The current form." }, { "name": "entry", "type": "array", "description": "The entry currently being displayed." } ], "categories": [ "entries", "after" ], "example": "add_action( 'gravityflow_entry_detail_content_after', function($form, $entry) {\n // Your code here\n}, 10, 2 );", "since": "[2.8.4](../../since/2-8-4/)", "source": { "file": "includes/pages/class-entry-detail.php", "line": 193 }, "url": "/docs/gravityflow/actions/gravityflow_entry_detail_content_after/", "related": [ "gravityflow_entry_detail_content_before" ] }, { "id": "gravityflow_entry_detail_content_before", "name": "gravityflow_entry_detail_content_before", "type": "action", "product": "gravityflow", "description": "Allows customized markup to be included before the entry details grid.", "parameters": [ { "name": "form", "type": "array", "description": "The current form." }, { "name": "entry", "type": "array", "description": "The entry currently being displayed." } ], "categories": [ "entries", "before" ], "example": "add_action( 'gravityflow_entry_detail_content_before', function($form, $entry) {\n // Your code here\n}, 10, 2 );", "since": "[1.0](../../since/1-0/)", "source": { "file": "includes/pages/class-entry-detail.php", "line": 139 }, "url": "/docs/gravityflow/actions/gravityflow_entry_detail_content_before/", "related": [ "gravityflow_entry_detail_content_after" ] }, { "id": "gravityflow_post_update_post", "name": "gravityflow_post_update_post", "type": "action", "product": "gravityflow", "description": "Allow custom actions to be performed after the post is updated.", "parameters": [ { "name": "post", "type": "array", "description": "The post which was updated." }, { "name": "feed", "type": "array", "description": "The feed which was processed." }, { "name": "current_step", "type": "\\Gravity_Flow_Step_Feed_Post_Update", "description": "The current step." } ], "categories": [ "after" ], "example": "add_action( 'gravityflow_post_update_post', function($post, $feed, $current_step) {\n // Your code here\n}, 10, 3 );", "since": "[2.7.9](../../since/2-7-9/)", "source": { "file": "includes/steps/class-step-feed-post-update.php", "line": 263 }, "url": "/docs/gravityflow/actions/gravityflow_post_update_post/", "related": [] }, { "id": "gravityflow_pre_cancel_workflow", "name": "gravityflow_pre_cancel_workflow", "type": "action", "product": "gravityflow", "description": "Fires before a workflow is cancelled.", "parameters": [ { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "form", "type": "array", "description": "The current form." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step object." } ], "categories": [ "before" ], "example": "add_action( 'gravityflow_pre_cancel_workflow', function($entry, $form, $step) {\n // Your code here\n}, 10, 3 );", "since": null, "source": { "file": "includes/class-api.php", "line": 123 }, "url": "/docs/gravityflow/actions/gravityflow_pre_cancel_workflow/", "related": [] }, { "id": "gravityflow_pre_restart_workflow", "name": "gravityflow_pre_restart_workflow", "type": "action", "product": "gravityflow", "description": "Fires just before the workflow restarts for an entry.", "parameters": [ { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "form", "type": "array", "description": "The current form." } ], "categories": [ "api", "before" ], "example": "add_action( 'gravityflow_pre_restart_workflow', function($entry, $form) {\n // Your code here\n}, 10, 2 );", "since": "[1.4.3](../../since/1-4-3/)", "source": { "file": "includes/class-api.php", "line": 179 }, "url": "/docs/gravityflow/actions/gravityflow_pre_restart_workflow/", "related": [] }, { "id": "gravityflow_step_complete", "name": "gravityflow_step_complete", "type": "action", "product": "gravityflow", "description": "Allows custom logic to be added when the step is started.", "parameters": [ { "name": "step_id", "type": "int", "description": "The ID of the completed step." }, { "name": "entry_id", "type": "int", "description": "The entry of the completed step." }, { "name": "form_id", "type": "int", "description": "The form of the completed step." }, { "name": "status", "type": "string", "description": "The status when the step completed." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The completed step." } ], "categories": [ "general" ], "example": "add_action( 'gravityflow_step_complete', function($step_id, $entry_id, $form_id, $status, $step) {\n // Your code here\n}, 10, 5 );", "since": "[1.3.0.10](../../since/1-3-0-10/)", "source": { "file": "includes/steps/class-step.php", "line": 2063 }, "url": "/docs/gravityflow/actions/gravityflow_step_complete/", "related": [] }, { "id": "gravityflow_step_start", "name": "gravityflow_step_start", "type": "action", "product": "gravityflow", "description": "Allows custom logic to be added when the step is started.", "parameters": [ { "name": "step_id", "type": "int", "description": "The ID of the step." }, { "name": "entry_id", "type": "int", "description": "The entry of the step." }, { "name": "form_id", "type": "int", "description": "The form of the step." }, { "name": "status", "type": "string", "description": "The status when the step starts." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The step." } ], "categories": [ "general" ], "example": "add_action( 'gravityflow_step_start', function($step_id, $entry_id, $form_id, $status, $step) {\n // Your code here\n}, 10, 5 );", "since": "[2.7.1](../../since/2-7-1/)", "source": { "file": "includes/steps/class-step.php", "line": 646 }, "url": "/docs/gravityflow/actions/gravityflow_step_start/", "related": [] }, { "id": "post_edd_sl_plugin_updater_setup", "name": "post_edd_sl_plugin_updater_setup", "type": "action", "product": "gravityflow", "description": "Fires after the $edd_plugin_data is setup.", "parameters": [ { "name": "edd_plugin_data", "type": "array", "description": "Array of EDD SL plugin data." } ], "categories": [ "after" ], "example": "add_action( 'post_edd_sl_plugin_updater_setup', function($edd_plugin_data) {\n // Your code here\n}, 10, 1 );", "since": "x.x.x: x.x.x", "source": { "file": "includes/EDD_SL_Plugin_Updater.php", "line": 57 }, "url": "/docs/gravityflow/actions/post_edd_sl_plugin_updater_setup/", "related": [] }, { "id": "gform_order_label", "name": "gform_order_label", "type": "filter", "product": "gravityflow", "description": ":::info[Dynamic Hook Name]", "parameters": [ { "name": "order_summary_label", "type": "string", "description": "The order summary label." }, { "name": "form_id", "type": "int", "description": "The current form ID." } ], "categories": [ "forms" ], "example": "add_filter( 'gform_order_label', function($order_summary_label, $form_id) {\n // Modify $order_summary_label as needed\n return $order_summary_label;\n}, 10, 2 );", "since": "unknown: unknown", "source": { "file": "includes/pages/class-entry-detail.php", "line": 868 }, "url": "/docs/gravityflow/filters/gform_order_label/", "related": [] }, { "id": "gform_order_summary", "name": "gform_order_summary", "type": "filter", "product": "gravityflow", "description": ":::info[Dynamic Hook Name]", "parameters": [], "categories": [ "forms" ], "example": "add_filter( 'gform_order_summary', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[2.3.4](../../since/2-3-4/)", "source": { "file": "includes/pages/class-entry-detail.php", "line": 894 }, "url": "/docs/gravityflow/filters/gform_order_summary/", "related": [] }, { "id": "gform_pre_validation", "name": "gform_pre_validation", "type": "filter", "product": "gravityflow", "description": ":::info[Dynamic Hook Name]", "parameters": [ { "name": "form", "type": "array", "description": "The current form." } ], "categories": [ "forms", "before" ], "example": "add_filter( 'gform_pre_validation', function($form) {\n // Modify $form as needed\n return $form;\n}, 10, 1 );", "since": "[2.5.10](../../since/2-5-10/)", "source": { "file": "includes/steps/traits/trait-editable-fields.php", "line": 259 }, "url": "/docs/gravityflow/filters/gform_pre_validation/", "related": [] }, { "id": "gravityflow_admin_action_feedback", "name": "gravityflow_admin_action_feedback", "type": "filter", "product": "gravityflow", "description": "Allows the feedback for the admin action to be modified. Also allows custom admin actions to be processed.", "parameters": [ { "name": "feedback", "type": "string", "description": "A string with the feedback to be displayed to the user or an instance of WP_Error." }, { "name": "admin_action", "type": "string", "description": "The admin action." }, { "name": "form", "type": "array", "description": "The form array." }, { "name": "entry", "type": "array", "description": "The entry array." } ], "categories": [ "admin" ], "example": "add_filter( 'gravityflow_admin_action_feedback', function($feedback, $admin_action, $form, $entry) {\n // Modify $feedback as needed\n return $feedback;\n}, 10, 4 );", "since": null, "source": { "file": "class-gravity-flow.php", "line": 5690 }, "url": "/docs/gravityflow/filters/gravityflow_admin_action_feedback/", "related": [] }, { "id": "gravityflow_admin_actions_workflow_detail", "name": "gravityflow_admin_actions_workflow_detail", "type": "filter", "product": "gravityflow", "description": "Filter the choices which appear in the admin actions drop down.", "parameters": [ { "name": "admin_actions", "type": "array", "description": "Contains the properties for the options and optgroups." }, { "name": "current_step", "type": "bool\\", "description": "\\Gravity_Flow_Step`" }, { "name": "steps", "type": "\\Gravity_Flow_Step[]", "description": "The steps for this form." }, { "name": "form", "type": "array", "description": "The current form." }, { "name": "entry", "type": "array", "description": "The current entry," } ], "categories": [ "admin" ], "example": "add_filter( 'gravityflow_admin_actions_workflow_detail', function($admin_actions, $current_step, $steps, $form, $entry) {\n // Modify $admin_actions as needed\n return $admin_actions;\n}, 10, 5 );", "since": null, "source": { "file": "class-gravity-flow.php", "line": 4005 }, "url": "/docs/gravityflow/filters/gravityflow_admin_actions_workflow_detail/", "related": [] }, { "id": "gravityflow_approval_assignee_status_feedback", "name": "gravityflow_approval_assignee_status_feedback", "type": "filter", "product": "gravityflow", "description": "Allows the assignee status feedback of approval step to be modified.", "parameters": [ { "name": "status_feedback", "type": "bool\\", "description": "string`" }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The assignee object." }, { "name": "new_status", "type": "string", "description": "The new status" }, { "name": "form", "type": "array", "description": "The current form array." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step" } ], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_approval_assignee_status_feedback', function($status_feedback, $assignee, $new_status, $form, $step) {\n // Modify $status_feedback as needed\n return $status_feedback;\n}, 10, 5 );", "since": "[2.9.8](../../since/2-9-8/)", "source": { "file": "includes/steps/class-step-approval.php", "line": 630 }, "url": "/docs/gravityflow/filters/gravityflow_approval_assignee_status_feedback/", "related": [] }, { "id": "gravityflow_approval_assignee_status_types", "name": "gravityflow_approval_assignee_status_types", "type": "filter", "product": "gravityflow", "description": "Allows the status types of the approval step process to be modified.", "parameters": [ { "name": "status_types", "type": "array", "description": "The status types the approval step will process." }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The assignee object." }, { "name": "new_status", "type": "string", "description": "The new status" }, { "name": "form", "type": "array", "description": "The current form array." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step" } ], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_approval_assignee_status_types', function($status_types, $assignee, $new_status, $form, $step) {\n // Modify $status_types as needed\n return $status_types;\n}, 10, 5 );", "since": "[2.9.8](../../since/2-9-8/)", "source": { "file": "includes/steps/class-step-approval.php", "line": 609 }, "url": "/docs/gravityflow/filters/gravityflow_approval_assignee_status_types/", "related": [] }, { "id": "gravityflow_approval_confirm_prompt_messages", "name": "gravityflow_approval_confirm_prompt_messages", "type": "filter", "product": "gravityflow", "description": "Allows the user to modify the messages for approval/rejection confirmation.", "parameters": [ { "name": "messages", "type": "array", "description": "The array containing approval/rejection messages." }, { "name": "form_id", "type": "int", "description": "The current form id." }, { "name": "entry", "type": "array", "description": "The current entry array." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_approval_confirm_prompt_messages', function($messages, $form_id, $entry, $step) {\n // Modify $messages as needed\n return $messages;\n}, 10, 4 );", "since": "[2.5.10](../../since/2-5-10/)", "source": { "file": "includes/steps/class-step-approval.php", "line": 960 }, "url": "/docs/gravityflow/filters/gravityflow_approval_confirm_prompt_messages/", "related": [] }, { "id": "gravityflow_approval_note_label_workflow_detail", "name": "gravityflow_approval_note_label_workflow_detail", "type": "filter", "product": "gravityflow", "description": "Allows the label for the Note field on the approval step to be modified.", "parameters": [ { "name": "", "type": "string", "description": "@note_label the label" }, { "name": "this", "type": "\\Gravity_Flow_Step_Approval", "description": "The current Approval Step." } ], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_approval_note_label_workflow_detail', function($, $this) {\n // Modify $value as needed\n return $value;\n}, 10, 2 );", "since": "[1.8.1](../../since/1-8-1/)", "source": { "file": "includes/steps/class-step-approval.php", "line": 915 }, "url": "/docs/gravityflow/filters/gravityflow_approval_note_label_workflow_detail/", "related": [] }, { "id": "gravityflow_approval_revert_step_id", "name": "gravityflow_approval_revert_step_id", "type": "filter", "product": "gravityflow", "description": "Allows the revert step to be modified before routing.", "parameters": [ { "name": "revert_step_id", "type": "string", "description": "The revert step ID from current step settings." }, { "name": "entry", "type": "array", "description": "The current entry array." }, { "name": "form", "type": "array", "description": "The current form array." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step" } ], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_approval_revert_step_id', function($revert_step_id, $entry, $form, $step) {\n // Modify $revert_step_id as needed\n return $revert_step_id;\n}, 10, 4 );", "since": "[2.5.6](../../since/2-5-6/)", "source": { "file": "includes/steps/class-step-approval.php", "line": 671 }, "url": "/docs/gravityflow/filters/gravityflow_approval_revert_step_id/", "related": [] }, { "id": "gravityflow_approve_label_workflow_detail", "name": "gravityflow_approve_label_workflow_detail", "type": "filter", "product": "gravityflow", "description": "Allows the 'Approve' label to be modified on the Approval step.", "parameters": [], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_approve_label_workflow_detail', function() {\n // Modify $value as needed\n return $value;\n} );", "since": null, "source": { "file": "includes/steps/class-step-approval.php", "line": 984 }, "url": "/docs/gravityflow/filters/gravityflow_approve_label_workflow_detail/", "related": [] }, { "id": "gravityflow_assignee_choices", "name": "gravityflow_assignee_choices", "type": "filter", "product": "gravityflow", "description": "Allows the assignee choices to be modified.", "parameters": [ { "name": "choices", "type": "array", "description": "The assignee choices" }, { "name": "form", "type": "array", "description": "The Form" } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_assignee_choices', function($choices, $form) {\n // Modify $choices as needed\n return $choices;\n}, 10, 2 );", "since": "[2.1](../../since/2-1/)", "source": { "file": "class-gravity-flow.php", "line": 1643 }, "url": "/docs/gravityflow/filters/gravityflow_assignee_choices/", "related": [] }, { "id": "gravityflow_assignee_email_reminder_repeat_days", "name": "gravityflow_assignee_email_reminder_repeat_days", "type": "filter", "product": "gravityflow", "description": ":::warning[Deprecated]", "parameters": [ { "name": "repeat_days", "type": "int", "description": "The number of days between each reminder." }, { "name": "form", "type": "array", "description": "The current form." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step." }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The current assignee." } ], "categories": [ "notifications" ], "example": "add_filter( 'gravityflow_assignee_email_reminder_repeat_days', function($repeat_days, $form, $entry, $step, $assignee) {\n // Modify $repeat_days as needed\n return $repeat_days;\n}, 10, 5 );", "since": null, "source": { "file": "class-gravity-flow.php", "line": 7193 }, "url": "/docs/gravityflow/filters/gravityflow_assignee_email_reminder_repeat_days/", "related": [] }, { "id": "gravityflow_assignee_status_list_user_input", "name": "gravityflow_assignee_status_list_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the assignee status list to be hidden.", "parameters": [ { "name": "form", "type": "array", "description": "The current form." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "current_step", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_assignee_status_list_user_input', function($form, $entry, $current_step) {\n // Modify $form as needed\n return $form;\n}, 10, 3 );", "since": null, "source": { "file": "includes/steps/class-step-user-input.php", "line": 614 }, "url": "/docs/gravityflow/filters/gravityflow_assignee_status_list_user_input/", "related": [] }, { "id": "gravityflow_assignee_status_workflow_detail", "name": "gravityflow_assignee_status_workflow_detail", "type": "filter", "product": "gravityflow", "description": "Allows the status label to be customized.", "parameters": [ { "name": "assignee_status_label", "type": "string", "description": "Indicates if non-site user notification for this step." }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The notification properties." }, { "name": "step", "type": "null\\", "description": "\\Gravity_Flow_Step`" } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_assignee_status_workflow_detail', function($assignee_status_label, $assignee, $step) {\n // Modify $assignee_status_label as needed\n return $assignee_status_label;\n}, 10, 3 );", "since": "[2.8.2](../../since/2-8-2/)", "source": { "file": "includes/assignees/class-assignee.php", "line": 580 }, "url": "/docs/gravityflow/filters/gravityflow_assignee_status_workflow_detail/", "related": [] }, { "id": "gravityflow_back_link_url_entry_detail", "name": "gravityflow_back_link_url_entry_detail", "type": "filter", "product": "gravityflow", "description": "Allows customization of the back link", "parameters": [], "categories": [ "entries" ], "example": "add_filter( 'gravityflow_back_link_url_entry_detail', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[2.5](../../since/2-5/)", "source": { "file": "includes/pages/class-entry-detail.php", "line": 369 }, "url": "/docs/gravityflow/filters/gravityflow_back_link_url_entry_detail/", "related": [] }, { "id": "gravityflow_bulk_action_status_table", "name": "gravityflow_bulk_action_status_table", "type": "filter", "product": "gravityflow", "description": "Allows custom bulk actions to be processed in the status table.", "parameters": [ { "name": "feedback", "type": "string\\", "description": "\\WP_Error`" }, { "name": "bulk_action", "type": "string", "description": "The action." }, { "name": "entry_ids", "type": "array", "description": "The entry IDs to be processed." }, { "name": "this", "type": "array", "description": "->args The args for this table." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_bulk_action_status_table', function($feedback, $bulk_action, $entry_ids, $this) {\n // Modify $feedback as needed\n return $feedback;\n}, 10, 4 );", "since": null, "source": { "file": "includes/pages/class-status.php", "line": 2052 }, "url": "/docs/gravityflow/filters/gravityflow_bulk_action_status_table/", "related": [] }, { "id": "gravityflow_can_render_form", "name": "gravityflow_can_render_form", "type": "filter", "product": "gravityflow", "description": "Controls whether a form can be rendered.", "parameters": [ { "name": "can_render_form", "type": "bool\\", "description": "\\WP_Error`" }, { "name": "form_id", "type": "int", "description": "The Form ID" } ], "categories": [ "rendering", "forms" ], "example": "add_filter( 'gravityflow_can_render_form', function($can_render_form, $form_id) {\n // Modify $can_render_form as needed\n return $can_render_form;\n}, 10, 2 );", "since": "[2.5.4](../../since/2-5-4/)", "source": { "file": "class-gravity-flow.php", "line": 5106 }, "url": "/docs/gravityflow/filters/gravityflow_can_render_form/", "related": [] }, { "id": "gravityflow_columns_inbox_table", "name": "gravityflow_columns_inbox_table", "type": "filter", "product": "gravityflow", "description": "Allows the columns to be filtered for the inbox table.", "parameters": [ { "name": "columns", "type": "array", "description": "The columns to be filtered" }, { "name": "args", "type": "array", "description": "The array of args for this inbox table." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_columns_inbox_table', function($columns, $args) {\n // Modify $columns as needed\n return $columns;\n}, 10, 2 );", "since": "[2.2.4](../../since/2-2-4/)-dev", "source": { "file": "includes/inbox/models/class-task.php", "line": 171 }, "url": "/docs/gravityflow/filters/gravityflow_columns_inbox_table/", "related": [] }, { "id": "gravityflow_columns_status_table", "name": "gravityflow_columns_status_table", "type": "filter", "product": "gravityflow", "description": "Allows the columns to be filtered for the status table.", "parameters": [ { "name": "columns", "type": "array", "description": "The columns to be filtered" }, { "name": "args", "type": "array", "description": "The array of args for this status table." }, { "name": "this", "type": "\\WP_List_Table", "description": "The current WP_List_Table object." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_columns_status_table', function($columns, $args, $this) {\n // Modify $columns as needed\n return $columns;\n}, 10, 3 );", "since": "[1.7.1](../../since/1-7-1/)", "source": { "file": "includes/pages/class-status.php", "line": 1311 }, "url": "/docs/gravityflow/filters/gravityflow_columns_status_table/", "related": [] }, { "id": "gravityflow_complete_label_user_input", "name": "gravityflow_complete_label_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the 'complete' label to be modified on the User Input step.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_complete_label_user_input', function() {\n // Modify $value as needed\n return $value;\n} );", "since": null, "source": { "file": "includes/steps/class-step-user-input.php", "line": 696 }, "url": "/docs/gravityflow/filters/gravityflow_complete_label_user_input/", "related": [] }, { "id": "gravityflow_date_format_current_step_merge_tag", "name": "gravityflow_date_format_current_step_merge_tag", "type": "filter", "product": "gravityflow", "description": "Allows the format for dates within current step merge tag to be modified.", "parameters": [ { "name": "date_format", "type": "string", "description": "A date format string - defaults to the WordPress settings." }, { "name": "current_step", "type": "\\Gravity_Flow_Step", "description": "The current step for this entry." }, { "name": "property", "type": "string", "description": "Modifier for the current step merge tag." } ], "categories": [ "forms" ], "example": "add_filter( 'gravityflow_date_format_current_step_merge_tag', function($date_format, $current_step, $property) {\n // Modify $date_format as needed\n return $date_format;\n}, 10, 3 );", "since": "[2.2.4](../../since/2-2-4/)-dev", "source": { "file": "includes/merge-tags/class-merge-tag-current-step.php", "line": 81 }, "url": "/docs/gravityflow/filters/gravityflow_date_format_current_step_merge_tag/", "related": [] }, { "id": "gravityflow_date_format_entry_detail", "name": "gravityflow_date_format_entry_detail", "type": "filter", "product": "gravityflow", "description": "Allows the format for dates within the entry detail workflow info box to be modified.", "parameters": [ { "name": "date_format", "type": "string", "description": "A date format string - defaults to the date format setting in the WordPress general settings." } ], "categories": [ "entries", "forms" ], "example": "add_filter( 'gravityflow_date_format_entry_detail', function($date_format) {\n // Modify $date_format as needed\n return $date_format;\n}, 10, 1 );", "since": null, "source": { "file": "class-gravity-flow.php", "line": 3790 }, "url": "/docs/gravityflow/filters/gravityflow_date_format_entry_detail/", "related": [] }, { "id": "gravityflow_discussion_items_display_limit", "name": "gravityflow_discussion_items_display_limit", "type": "filter", "product": "gravityflow", "description": "Set the amount of discussion items to be shown in non-print inbox / status view when toggle is active.", "parameters": [ { "name": "max_display_limit", "type": "int", "description": "Amount of comments to be shown. Default is 10." }, { "name": "this", "type": "\\Gravity_Flow_Field_Discussion", "description": "The field currently being processed." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_discussion_items_display_limit', function($max_display_limit, $this) {\n // Modify $max_display_limit as needed\n return $max_display_limit;\n}, 10, 2 );", "since": "[1.9.2](../../since/1-9-2/)-dev", "source": { "file": "includes/fields/class-field-discussion.php", "line": 275 }, "url": "/docs/gravityflow/filters/gravityflow_discussion_items_display_limit/", "related": [] }, { "id": "gravityflow_discussion_items_display_toggle", "name": "gravityflow_discussion_items_display_toggle", "type": "filter", "product": "gravityflow", "description": "Whether to show / hide the toggle to display more discussion items.", "parameters": [ { "name": "hide_toggle", "type": "bool", "description": "Whether to prevent the display more toggle from displaying." }, { "name": "this", "type": "\\Gravity_Flow_Field_Discussion", "description": "The field currently being processed." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_discussion_items_display_toggle', function($hide_toggle, $this) {\n // Modify $hide_toggle as needed\n return $hide_toggle;\n}, 10, 2 );", "since": "[2.0.2](../../since/2-0-2/)", "source": { "file": "includes/fields/class-field-discussion.php", "line": 264 }, "url": "/docs/gravityflow/filters/gravityflow_discussion_items_display_toggle/", "related": [] }, { "id": "gravityflow_display_name_discussion_field", "name": "gravityflow_display_name_discussion_field", "type": "filter", "product": "gravityflow", "description": "Allow the discussion field display name to be modified before display.", "parameters": [ { "name": "display_name", "type": "string", "description": "The discussion field display name." }, { "name": "item", "type": "array", "description": "The discussion item data." }, { "name": "this", "type": "\\Gravity_Flow_Field_Discussion", "description": "The field currently being processed." } ], "categories": [ "fields" ], "example": "add_filter( 'gravityflow_display_name_discussion_field', function($display_name, $item, $this) {\n // Modify $display_name as needed\n return $display_name;\n}, 10, 3 );", "since": "[3.0.1](../../since/3-0-1/)", "source": { "file": "includes/fields/class-field-discussion.php", "line": 382 }, "url": "/docs/gravityflow/filters/gravityflow_display_name_discussion_field/", "related": [] }, { "id": "gravityflow_editable_fields", "name": "gravityflow_editable_fields", "type": "filter", "product": "gravityflow", "description": ":::info[Dynamic Hook Name]", "parameters": [ { "name": "editable_fields", "type": "array", "description": "The current array of editable fields" }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "fields", "editing" ], "example": "add_filter( 'gravityflow_editable_fields', function($editable_fields, $this) {\n // Modify $editable_fields as needed\n return $editable_fields;\n}, 10, 2 );", "since": "[2.9.1](../../since/2-9-1/): moved to trait-editable-fields.php and expanded from a general filter as well as by step type that supports editable fields.", "source": { "file": "includes/steps/traits/trait-editable-fields.php", "line": 163 }, "url": "/docs/gravityflow/filters/gravityflow_editable_fields/", "related": [] }, { "id": "gravityflow_entry_detail_args", "name": "gravityflow_entry_detail_args", "type": "filter", "product": "gravityflow", "description": "Allow the entry detail arguments to be overridden.", "parameters": [ { "name": "args", "type": "array", "description": "The entry detail page arguments." } ], "categories": [ "entries" ], "example": "add_filter( 'gravityflow_entry_detail_args', function($args) {\n // Modify $args as needed\n return $args;\n}, 10, 1 );", "since": "[2.5](../../since/2-5/)", "source": { "file": "includes/pages/class-entry-detail.php", "line": 233 }, "url": "/docs/gravityflow/filters/gravityflow_entry_detail_args/", "related": [] }, { "id": "gravityflow_entry_link_inbox_table", "name": "gravityflow_entry_link_inbox_table", "type": "filter", "product": "gravityflow", "description": "Allows the entry link to be modified for each of the entries in the inbox table.", "parameters": [ { "name": "link", "type": "string", "description": "The entry link HTML." }, { "name": "url_entry", "type": "string", "description": "The entry URL." }, { "name": "entry", "type": "string", "description": "The current entry." }, { "name": "args", "type": "string", "description": "The inbox page arguments." } ], "categories": [ "entries" ], "example": "add_filter( 'gravityflow_entry_link_inbox_table', function($link, $url_entry, $entry, $args) {\n // Modify $link as needed\n return $link;\n}, 10, 4 );", "since": "[1.9.2](../../since/1-9-2/)", "source": { "file": "includes/pages/class-inbox.php", "line": 284 }, "url": "/docs/gravityflow/filters/gravityflow_entry_link_inbox_table/", "related": [] }, { "id": "gravityflow_entry_this-get_type_response_mapping", "name": "gravityflow_entry_\\{$this->get_type()\\}_response_mapping", "type": "filter", "product": "gravityflow", "description": "Allow the entry to be modified during the response mapping of the webhook step.", "parameters": [ { "name": "entry", "type": "array", "description": "The entry currently being processed." }, { "name": "mapping", "type": "array", "description": "The mapping currently being processed." }, { "name": "data", "type": "array", "description": "The response headers or body data." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." }, { "name": "mapping_type", "type": "string", "description": "The mapping type: header or body." } ], "categories": [ "entries", "maps" ], "example": "add_filter( 'gravityflow_entry_\\{$this->get_type()\\}_response_mapping', function($entry, $mapping, $data, $this, $mapping_type) {\n // Modify $entry as needed\n return $entry;\n}, 10, 5 );", "since": "[2.2.4](../../since/2-2-4/)-dev", "source": { "file": "includes/steps/traits/trait-response-mapping.php", "line": 352 }, "url": "/docs/gravityflow/filters/gravityflow_entry_this-get_type_response_mapping/", "related": [] }, { "id": "gravityflow_entry_url_inbox_table", "name": "gravityflow_entry_url_inbox_table", "type": "filter", "product": "gravityflow", "description": "Allows the entry URL to be modified for each of the entries in the inbox table.", "parameters": [ { "name": "url_entry", "type": "string", "description": "The entry URL." }, { "name": "entry", "type": "string", "description": "The current entry." }, { "name": "args", "type": "string", "description": "The inbox page arguments." }, { "name": "form", "type": "array", "description": "The form object for the current entry." } ], "categories": [ "entries" ], "example": "add_filter( 'gravityflow_entry_url_inbox_table', function($url_entry, $entry, $args, $form) {\n // Modify $url_entry as needed\n return $url_entry;\n}, 10, 4 );", "since": "[2.5.6](../../since/2-5-6/)", "source": { "file": "includes/pages/class-inbox.php", "line": 270 }, "url": "/docs/gravityflow/filters/gravityflow_entry_url_inbox_table/", "related": [] }, { "id": "gravityflow_entry_url_status_table", "name": "gravityflow_entry_url_status_table", "type": "filter", "product": "gravityflow", "description": "Allows the entry url to be filtered in the status table.", "parameters": [ { "name": "entry_url", "type": "string", "description": "The url to be linked to." }, { "name": "form_id", "type": "int", "description": "The Form ID." }, { "name": "entry_id", "type": "int", "description": "The Entry ID." }, { "name": "entry", "type": "array", "description": "The entry array." } ], "categories": [ "entries" ], "example": "add_filter( 'gravityflow_entry_url_status_table', function($entry_url, $form_id, $entry_id, $entry) {\n // Modify $entry_url as needed\n return $entry_url;\n}, 10, 4 );", "since": "[2.6.1](../../since/2-6-1/)", "source": { "file": "includes/pages/class-status.php", "line": 1152 }, "url": "/docs/gravityflow/filters/gravityflow_entry_url_status_table/", "related": [] }, { "id": "gravityflow_event_limit_activity_page", "name": "gravityflow_event_limit_activity_page", "type": "filter", "product": "gravityflow", "description": "Filters the limit value.", "parameters": [ { "name": "limit", "type": "int", "description": "The limit of events." } ], "categories": [ "calendar" ], "example": "add_filter( 'gravityflow_event_limit_activity_page', function($limit) {\n // Modify $limit as needed\n return $limit;\n}, 10, 1 );", "since": "[2.0.2](../../since/2-0-2/): Allows the limit for events to be modified before events are displayed on the activity page.", "source": { "file": "includes/pages/class-activity.php", "line": 49 }, "url": "/docs/gravityflow/filters/gravityflow_event_limit_activity_page/", "related": [] }, { "id": "gravityflow_feed_condition_entry_properties", "name": "gravityflow_feed_condition_entry_properties", "type": "filter", "product": "gravityflow", "description": "Allows feed condition entry properties to be modified for the form.", "parameters": [ { "name": "properties", "type": "array", "description": "The feed condition entry properties." }, { "name": "form_id", "type": "int", "description": "Form id." } ], "categories": [ "entries" ], "example": "add_filter( 'gravityflow_feed_condition_entry_properties', function($properties, $form_id) {\n // Modify $properties as needed\n return $properties;\n}, 10, 2 );", "since": "[2.2.4](../../since/2-2-4/)-dev", "source": { "file": "class-gravity-flow.php", "line": 8298 }, "url": "/docs/gravityflow/filters/gravityflow_feed_condition_entry_properties/", "related": [] }, { "id": "gravityflow_feedback_approval", "name": "gravityflow_feedback_approval", "type": "filter", "product": "gravityflow", "description": "Allows the user feedback to be modified after processing the approval status update.", "parameters": [ { "name": "feedback", "type": "string", "description": "The feedback to send to the browser." }, { "name": "entry", "type": "array", "description": "The current entry array." }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The assignee object." }, { "name": "new_status", "type": "string", "description": "The new status" }, { "name": "form", "type": "array", "description": "The current form array." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step" } ], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_feedback_approval', function($feedback, $entry, $assignee, $new_status, $form, $step) {\n // Modify $feedback as needed\n return $feedback;\n}, 10, 6 );", "since": "[1.7.1](../../since/1-7-1/)", "source": { "file": "includes/steps/class-step-approval.php", "line": 1300 }, "url": "/docs/gravityflow/filters/gravityflow_feedback_approval/", "related": [] }, { "id": "gravityflow_feedback_approval_token", "name": "gravityflow_feedback_approval_token", "type": "filter", "product": "gravityflow", "description": "Allows the user feedback to be modified after processing the token action.", "parameters": [ { "name": "feedback", "type": "string", "description": "The feedback to send to the browser." }, { "name": "entry", "type": "array", "description": "The current entry array." }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The assignee object." }, { "name": "new_status", "type": "string", "description": "The new status" }, { "name": "form", "type": "array", "description": "The current form array." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step" } ], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_feedback_approval_token', function($feedback, $entry, $assignee, $new_status, $form, $step) {\n // Modify $feedback as needed\n return $feedback;\n}, 10, 6 );", "since": "[2.0.2](../../since/2-0-2/): Added the current step", "source": { "file": "includes/steps/class-step-approval.php", "line": 1154 }, "url": "/docs/gravityflow/filters/gravityflow_feedback_approval_token/", "related": [] }, { "id": "gravityflow_feedback_cancel_workflow", "name": "gravityflow_feedback_cancel_workflow", "type": "filter", "product": "gravityflow", "description": "Allows the user feedback to be modified after cancelling the workflow with the cancel link.", "parameters": [ { "name": "feedback", "type": "string", "description": "The sanitized feedback to send to the browser." }, { "name": "entry", "type": "array", "description": "The current entry array." }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The assignee object." }, { "name": "new_status", "type": "string", "description": "The new status" }, { "name": "form", "type": "array", "description": "The current form array." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step" } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_feedback_cancel_workflow', function($feedback, $entry, $assignee, $new_status, $form, $step) {\n // Modify $feedback as needed\n return $feedback;\n}, 10, 6 );", "since": "[2.0.2](../../since/2-0-2/)", "source": { "file": "class-gravity-flow.php", "line": 5285 }, "url": "/docs/gravityflow/filters/gravityflow_feedback_cancel_workflow/", "related": [] }, { "id": "gravityflow_feedback_message_user_input", "name": "gravityflow_feedback_message_user_input", "type": "filter", "product": "gravityflow", "description": "Allow the feedback message to be modified on the user input step.", "parameters": [ { "name": "feedback", "type": "string", "description": "The message to be displayed to the assignee when the detail page is redisplayed." }, { "name": "new_status", "type": "string", "description": "The new status." }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The assignee properties." }, { "name": "form", "type": "array", "description": "The current form." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_feedback_message_user_input', function($feedback, $new_status, $assignee, $form, $this) {\n // Modify $feedback as needed\n return $feedback;\n}, 10, 5 );", "since": null, "source": { "file": "includes/steps/class-step-user-input.php", "line": 403 }, "url": "/docs/gravityflow/filters/gravityflow_feedback_message_user_input/", "related": [] }, { "id": "gravityflow_field_filters_status_table", "name": "gravityflow_field_filters_status_table", "type": "filter", "product": "gravityflow", "description": "Allows modification of the field filters in the status table.", "parameters": [ { "name": "field_filters", "type": "array", "description": "An associative array of filters by Form ID." } ], "categories": [ "fields", "search" ], "example": "add_filter( 'gravityflow_field_filters_status_table', function($field_filters) {\n // Modify $field_filters as needed\n return $field_filters;\n}, 10, 1 );", "since": null, "source": { "file": "includes/pages/class-status.php", "line": 640 }, "url": "/docs/gravityflow/filters/gravityflow_field_filters_status_table/", "related": [] }, { "id": "gravityflow_field_value_status_table", "name": "gravityflow_field_value_status_table", "type": "filter", "product": "gravityflow", "description": "Allows the field value to be filtered in the status table.", "parameters": [ { "name": "value", "type": "string", "description": "The value to be displayed." }, { "name": "form_id", "type": "int", "description": "The Form ID." }, { "name": "column_name", "type": "string", "description": "The column name." }, { "name": "item", "type": "array", "description": "The entry array." } ], "categories": [ "fields" ], "example": "add_filter( 'gravityflow_field_value_status_table', function($value, $form_id, $column_name, $item) {\n // Modify $value as needed\n return $value;\n}, 10, 4 );", "since": "[1.7.1](../../since/1-7-1/)", "source": { "file": "includes/pages/class-status.php", "line": 1179 }, "url": "/docs/gravityflow/filters/gravityflow_field_value_status_table/", "related": [] }, { "id": "gravityflow_form_ids_inbox", "name": "gravityflow_form_ids_inbox", "type": "filter", "product": "gravityflow", "description": "Allows form id(s) to be adjusted to define which forms' entries are displayed in inbox table.", "parameters": [ { "name": "form_ids", "type": "array", "description": "The form ids" }, { "name": "search_criteria", "type": "array", "description": "The search criteria" } ], "categories": [ "forms" ], "example": "add_filter( 'gravityflow_form_ids_inbox', function($form_ids, $search_criteria) {\n // Modify $form_ids as needed\n return $form_ids;\n}, 10, 2 );", "since": "[2.2.2](../../since/2-2-2/)-dev", "source": { "file": "includes/class-api.php", "line": 524 }, "url": "/docs/gravityflow/filters/gravityflow_form_ids_inbox/", "related": [] }, { "id": "gravityflow_form_ids_status", "name": "gravityflow_form_ids_status", "type": "filter", "product": "gravityflow", "description": "Allows form id(s) to be adjusted to define which forms' entries are displayed in status table.", "parameters": [ { "name": "form_ids", "type": "array", "description": "The form ids" }, { "name": "search_criteria", "type": "array", "description": "The search criteria" } ], "categories": [ "forms" ], "example": "add_filter( 'gravityflow_form_ids_status', function($form_ids, $search_criteria) {\n // Modify $form_ids as needed\n return $form_ids;\n}, 10, 2 );", "since": "[2.2.3](../../since/2-2-3/)", "source": { "file": "includes/pages/class-status.php", "line": 1485 }, "url": "/docs/gravityflow/filters/gravityflow_form_ids_status/", "related": [] }, { "id": "gravityflow_in_progress_label_user_input", "name": "gravityflow_in_progress_label_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the 'in progress' label to be modified on the User Input step.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_in_progress_label_user_input', function() {\n // Modify $value as needed\n return $value;\n} );", "since": null, "source": { "file": "includes/steps/class-step-user-input.php", "line": 686 }, "url": "/docs/gravityflow/filters/gravityflow_in_progress_label_user_input/", "related": [] }, { "id": "gravityflow_inbox_args", "name": "gravityflow_inbox_args", "type": "filter", "product": "gravityflow", "description": "Allow the inbox page arguments to be overridden.", "parameters": [ { "name": "args", "type": "array", "description": "The inbox page arguments." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_inbox_args', function($args) {\n // Modify $args as needed\n return $args;\n}, 10, 1 );", "since": null, "source": { "file": "includes/inbox/class-inbox-service-provider.php", "line": 294 }, "url": "/docs/gravityflow/filters/gravityflow_inbox_args/", "related": [] }, { "id": "gravityflow_inbox_field_value", "name": "gravityflow_inbox_field_value", "type": "filter", "product": "gravityflow", "description": "Allows the inbox value to be filtered before displaying in a grid.", "parameters": [], "categories": [ "fields" ], "example": "add_filter( 'gravityflow_inbox_field_value', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[2.8.2](../../since/2-8-2/)", "source": { "file": "includes/inbox/models/class-task.php", "line": 520 }, "url": "/docs/gravityflow/filters/gravityflow_inbox_field_value/", "related": [] }, { "id": "gravityflow_inbox_items_per_page_default", "name": "gravityflow_inbox_items_per_page_default", "type": "filter", "product": "gravityflow", "description": "Control the default rows per page for all inboxes.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_inbox_items_per_page_default', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[2.8.3](../../since/2-8-3/)", "source": { "file": "includes/inbox/class-inbox-service-provider.php", "line": 85 }, "url": "/docs/gravityflow/filters/gravityflow_inbox_items_per_page_default/", "related": [] }, { "id": "gravityflow_inbox_paging", "name": "gravityflow_inbox_paging", "type": "filter", "product": "gravityflow", "description": "Allows the paging criteria to be modified before entries are searched for the inbox.", "parameters": [ { "name": "paging", "type": "array", "description": "The paging criteria." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_inbox_paging', function($paging) {\n // Modify $paging as needed\n return $paging;\n}, 10, 1 );", "since": "[2.0.2](../../since/2-0-2/)", "source": { "file": "includes/class-api.php", "line": 560 }, "url": "/docs/gravityflow/filters/gravityflow_inbox_paging/", "related": [] }, { "id": "gravityflow_inbox_search_criteria", "name": "gravityflow_inbox_search_criteria", "type": "filter", "product": "gravityflow", "description": "Allows the search criteria to be modified before entries are searched for the inbox.", "parameters": [ { "name": "sorting", "type": "array", "description": "The search criteria." }, { "name": "args", "type": "array", "description": "The inbox configuration arguments." } ], "categories": [ "search" ], "example": "add_filter( 'gravityflow_inbox_search_criteria', function($sorting, $args) {\n // Modify $sorting as needed\n return $sorting;\n}, 10, 2 );", "since": "[2.1](../../since/2-1/)", "source": { "file": "includes/class-api.php", "line": 468 }, "url": "/docs/gravityflow/filters/gravityflow_inbox_search_criteria/", "related": [] }, { "id": "gravityflow_inbox_sorting", "name": "gravityflow_inbox_sorting", "type": "filter", "product": "gravityflow", "description": "Allows the sorting criteria to be modified before entries are searched for the inbox.", "parameters": [ { "name": "sorting", "type": "array", "description": "The sorting criteria." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_inbox_sorting', function($sorting) {\n // Modify $sorting as needed\n return $sorting;\n}, 10, 1 );", "since": null, "source": { "file": "includes/class-api.php", "line": 592 }, "url": "/docs/gravityflow/filters/gravityflow_inbox_sorting/", "related": [] }, { "id": "gravityflow_inbox_submitter_name", "name": "gravityflow_inbox_submitter_name", "type": "filter", "product": "gravityflow", "description": "Allow the value displayed in the Submitter column to be overridden.", "parameters": [ { "name": "submitter_name", "type": "string", "description": "The display_name of the logged-in user who submitted the form or the guest ip address." }, { "name": "entry", "type": "array", "description": "The entry object for the row currently being processed." }, { "name": "form", "type": "array", "description": "The form object for the current entry." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_inbox_submitter_name', function($submitter_name, $entry, $form) {\n // Modify $submitter_name as needed\n return $submitter_name;\n}, 10, 3 );", "since": null, "source": { "file": "includes/inbox/models/class-task.php", "line": 430 }, "url": "/docs/gravityflow/filters/gravityflow_inbox_submitter_name/", "related": [] }, { "id": "gravityflow_is_delayed_pre_process_workflow", "name": "gravityflow_is_delayed_pre_process_workflow", "type": "filter", "product": "gravityflow", "description": "Allow processing of the workflow to be delayed.", "parameters": [ { "name": "is_delayed", "type": "bool", "description": "Indicates if processing of the workflow should be delayed." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "form", "type": "array", "description": "The current form." } ], "categories": [ "before" ], "example": "add_filter( 'gravityflow_is_delayed_pre_process_workflow', function($is_delayed, $entry, $form) {\n // Modify $is_delayed as needed\n return $is_delayed;\n}, 10, 3 );", "since": "[2.0.2](../../since/2-0-2/)-dev", "source": { "file": "class-gravity-flow.php", "line": 5769 }, "url": "/docs/gravityflow/filters/gravityflow_is_delayed_pre_process_workflow/", "related": [] }, { "id": "gravityflow_js_config_admin", "name": "gravityflow_js_config_admin", "type": "filter", "product": "gravityflow", "description": "Allows third-party code to modify the config array sent to admin JS.", "parameters": [], "categories": [ "admin" ], "example": "add_filter( 'gravityflow_js_config_admin', function() {\n // Modify $value as needed\n return $value;\n} );", "since": null, "source": { "file": "includes/config/class-js-config.php", "line": 80 }, "url": "/docs/gravityflow/filters/gravityflow_js_config_admin/", "related": [] }, { "id": "gravityflow_js_config_shared", "name": "gravityflow_js_config_shared", "type": "filter", "product": "gravityflow", "description": "Allows third-party code to modify the config array sent to both admin and theme JS.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_js_config_shared', function() {\n // Modify $value as needed\n return $value;\n} );", "since": null, "source": { "file": "includes/config/class-js-config.php", "line": 64 }, "url": "/docs/gravityflow/filters/gravityflow_js_config_shared/", "related": [] }, { "id": "gravityflow_js_config_theme", "name": "gravityflow_js_config_theme", "type": "filter", "product": "gravityflow", "description": "Allows third-party code to modify the config array sent to theme JS.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_js_config_theme', function() {\n // Modify $value as needed\n return $value;\n} );", "since": null, "source": { "file": "includes/config/class-js-config.php", "line": 96 }, "url": "/docs/gravityflow/filters/gravityflow_js_config_theme/", "related": [] }, { "id": "gravityflow_major_version_auto_updates_allowed", "name": "gravityflow_major_version_auto_updates_allowed", "type": "filter", "product": "gravityflow", "description": "If major version updates are allowed we don't need to compare the branch version numbers.", "parameters": [ { "name": "allowed", "type": "bool", "description": "Indicates if Gravity Flow should update to major versions automatically. Default is true." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_major_version_auto_updates_allowed', function($allowed) {\n // Modify $allowed as needed\n return $allowed;\n}, 10, 1 );", "since": "[2.6](../../since/2-6/)", "source": { "file": "class-gravity-flow.php", "line": 6738 }, "url": "/docs/gravityflow/filters/gravityflow_major_version_auto_updates_allowed/", "related": [] }, { "id": "gravityflow_network_non_site_user_notification", "name": "gravityflow_network_non_site_user_notification", "type": "filter", "product": "gravityflow", "description": "Allows the non-site user notification to be enabled.", "parameters": [ { "name": "to_add_user", "type": "bool", "description": "Indicates if non-site user notification for this step." }, { "name": "user", "type": "[\\WP_User](https://developer.wordpress.org/reference/classes/wp_user/)", "description": "The user who is assignee for the current step." }, { "name": "notification", "type": "array", "description": "The notification properties." }, { "name": "assignee_id", "type": "int", "description": "The assignee ID - if applicable." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "step", "type": "null\\", "description": "\\Gravity_Flow_Step`" } ], "categories": [ "notifications" ], "example": "add_filter( 'gravityflow_network_non_site_user_notification', function($to_add_user, $user, $notification, $assignee_id, $entry, $step) {\n // Modify $to_add_user as needed\n return $to_add_user;\n}, 10, 6 );", "since": "[2.8.2](../../since/2-8-2/)", "source": { "file": "includes/assignees/class-assignee.php", "line": 428 }, "url": "/docs/gravityflow/filters/gravityflow_network_non_site_user_notification/", "related": [] }, { "id": "gravityflow_next_step", "name": "gravityflow_next_step", "type": "filter", "product": "gravityflow", "description": "Allows the next step in workflow to be customized.", "parameters": [ { "name": "step", "type": "\\Gravity_Flow_Step\\", "description": "bool`" }, { "name": "current_step", "type": "\\Gravity_Flow_Step", "description": "The current step." }, { "name": "entry", "type": "array", "description": "The current entry array." }, { "name": "form", "type": "array", "description": "The current form array." }, { "name": "steps", "type": "array", "description": "The steps for current form." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_next_step', function($step, $current_step, $entry, $form, $steps) {\n // Modify $step as needed\n return $step;\n}, 10, 5 );", "since": "[2.4.3](../../since/2-4-3/)", "source": { "file": "class-gravity-flow.php", "line": 4135 }, "url": "/docs/gravityflow/filters/gravityflow_next_step/", "related": [] }, { "id": "gravityflow_note_valid", "name": "gravityflow_note_valid", "type": "filter", "product": "gravityflow", "description": "Allows modification of note validity.", "parameters": [ { "name": "valid", "type": "bool", "description": "Indicates if the note is valid." }, { "name": "note", "type": "string", "description": "The submitted note." }, { "name": "new_status", "type": "string", "description": "The new status for the current step." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current workflow step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_note_valid', function($valid, $note, $new_status, $this) {\n // Modify $valid as needed\n return $valid;\n}, 10, 4 );", "since": null, "source": { "file": "includes/steps/class-step-user-input.php", "line": 468 }, "url": "/docs/gravityflow/filters/gravityflow_note_valid/", "related": [] }, { "id": "gravityflow_page_load_logic_setting", "name": "gravityflow_page_load_logic_setting", "type": "filter", "product": "gravityflow", "description": ":::info[Dynamic Hook Name]", "parameters": [ { "name": "do_display", "type": "bool", "description": "Wether or not to display the \"page load\" vs. \"dynamic\" option for the conditional logic setting. Defaults to false." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step object." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_page_load_logic_setting', function($do_display, $this) {\n // Modify $do_display as needed\n return $do_display;\n}, 10, 2 );", "since": "[2.9.1](../../since/2-9-1/): Added $this parameter. Expanded to also call a step type specific filter.", "source": { "file": "includes/steps/traits/trait-editable-fields.php", "line": 88 }, "url": "/docs/gravityflow/filters/gravityflow_page_load_logic_setting/", "related": [] }, { "id": "gravityflow_permission_denied_message_entry_detail", "name": "gravityflow_permission_denied_message_entry_detail", "type": "filter", "product": "gravityflow", "description": "Allows the the permission denied message to be overridden for the workflow entry detail page.", "parameters": [ { "name": "permission_denied_message", "type": "string", "description": "Whether permission is granted to open the entry." }, { "name": "current_step", "type": "null\\", "description": "\\Gravity_Flow_Step`" } ], "categories": [ "entries", "permissions" ], "example": "add_filter( 'gravityflow_permission_denied_message_entry_detail', function($permission_denied_message, $current_step) {\n // Modify $permission_denied_message as needed\n return $permission_denied_message;\n}, 10, 2 );", "since": "[2.5.8](../../since/2-5-8/)", "source": { "file": "includes/pages/class-entry-detail.php", "line": 114 }, "url": "/docs/gravityflow/filters/gravityflow_permission_denied_message_entry_detail/", "related": [] }, { "id": "gravityflow_permission_granted_entry_detail", "name": "gravityflow_permission_granted_entry_detail", "type": "filter", "product": "gravityflow", "description": "Allows the the permission check to be overridden for the workflow entry detail page.", "parameters": [ { "name": "permission_granted", "type": "bool", "description": "Whether permission is granted to open the entry." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "form", "type": "array", "description": "The form for the current entry." }, { "name": "current_step", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "entries", "permissions" ], "example": "add_filter( 'gravityflow_permission_granted_entry_detail', function($permission_granted, $entry, $form, $current_step) {\n // Modify $permission_granted as needed\n return $permission_granted;\n}, 10, 4 );", "since": null, "source": { "file": "includes/pages/class-print-entries.php", "line": 71 }, "url": "/docs/gravityflow/filters/gravityflow_permission_granted_entry_detail/", "related": [] }, { "id": "gravityflow_print_styles", "name": "gravityflow_print_styles", "type": "filter", "product": "gravityflow", "description": "Allows the print CSS styles that are output for print entries to be customized.", "parameters": [ { "name": "styles", "type": "array", "description": "The named CSS files to output through wp_print_styles." }, { "name": "entry_ids", "type": "array", "description": "The current entry(ies) which are set for print / bulk print." } ], "categories": [ "assets" ], "example": "add_filter( 'gravityflow_print_styles', function($styles, $entry_ids) {\n // Modify $styles as needed\n return $styles;\n}, 10, 2 );", "since": "[2.5.10](../../since/2-5-10/): Add $entry_ids to parameters", "source": { "file": "includes/pages/class-print-entries.php", "line": 204 }, "url": "/docs/gravityflow/filters/gravityflow_print_styles/", "related": [] }, { "id": "gravityflow_reject_label_workflow_detail", "name": "gravityflow_reject_label_workflow_detail", "type": "filter", "product": "gravityflow", "description": "Allows the 'Reject' label to be modified on the Approval step.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_reject_label_workflow_detail', function() {\n // Modify $value as needed\n return $value;\n} );", "since": null, "source": { "file": "includes/steps/class-step-approval.php", "line": 1003 }, "url": "/docs/gravityflow/filters/gravityflow_reject_label_workflow_detail/", "related": [] }, { "id": "gravityflow_reports_args", "name": "gravityflow_reports_args", "type": "filter", "product": "gravityflow", "description": "Allow the reports display arguments to be overridden.", "parameters": [ { "name": "args", "type": "array", "description": "The reports display arguments." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_reports_args', function($args) {\n // Modify $args as needed\n return $args;\n}, 10, 1 );", "since": "[2.5.10](../../since/2-5-10/)", "source": { "file": "includes/pages/class-reports.php", "line": 75 }, "url": "/docs/gravityflow/filters/gravityflow_reports_args/", "related": [] }, { "id": "gravityflow_response_message_webhook", "name": "gravityflow_response_message_webhook", "type": "filter", "product": "gravityflow", "description": "Allow the message logged to the timeline following webhook step to be modified", "parameters": [ { "name": "http_response_message", "type": "string", "description": "The status message derived from webhook response." }, { "name": "step_status", "type": "string", "description": "The step status derived from webhook response." }, { "name": "response", "type": "array", "description": "The response returned from webhook." }, { "name": "args", "type": "array", "description": "The arguments used for executing the webhook request." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_response_message_webhook', function($http_response_message, $step_status, $response, $args, $entry, $this) {\n // Modify $http_response_message as needed\n return $http_response_message;\n}, 10, 6 );", "since": null, "source": { "file": "includes/steps/class-step-webhook.php", "line": 894 }, "url": "/docs/gravityflow/filters/gravityflow_response_message_webhook/", "related": [] }, { "id": "gravityflow_rest_api_capability_cancel_workflow", "name": "gravityflow_rest_api_capability_cancel_workflow", "type": "filter", "product": "gravityflow", "description": "Filters the capability required to cancel a workflow via the REST API.", "parameters": [ { "name": "capability", "type": "string\\", "description": "array`" }, { "name": "request", "type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)", "description": "Full data about the request." } ], "categories": [ "permissions", "api" ], "example": "add_filter( 'gravityflow_rest_api_capability_cancel_workflow', function($capability, $request) {\n // Modify $capability as needed\n return $capability;\n}, 10, 2 );", "since": "[3.0.0](../../since/3-0-0/)", "source": { "file": "includes/rest-api/v2/controllers/class-controller-workflows.php", "line": 221 }, "url": "/docs/gravityflow/filters/gravityflow_rest_api_capability_cancel_workflow/", "related": [] }, { "id": "gravityflow_rest_api_capability_get_forms_steps", "name": "gravityflow_rest_api_capability_get_forms_steps", "type": "filter", "product": "gravityflow", "description": "Filters the capability required to get steps via the REST API.", "parameters": [ { "name": "capability", "type": "string\\", "description": "array`" }, { "name": "request", "type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)", "description": "Full data about the request." } ], "categories": [ "forms", "permissions", "api" ], "example": "add_filter( 'gravityflow_rest_api_capability_get_forms_steps', function($capability, $request) {\n // Modify $capability as needed\n return $capability;\n}, 10, 2 );", "since": "[3.0.0](../../since/3-0-0/)", "source": { "file": "includes/rest-api/v2/controllers/class-controller-steps.php", "line": 191 }, "url": "/docs/gravityflow/filters/gravityflow_rest_api_capability_get_forms_steps/", "related": [] }, { "id": "gravityflow_rest_api_capability_process_step", "name": "gravityflow_rest_api_capability_process_step", "type": "filter", "product": "gravityflow", "description": "Filters the capability required to start a step via the REST API.", "parameters": [ { "name": "capability", "type": "string\\", "description": "array`" }, { "name": "request", "type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)", "description": "Full data about the request." } ], "categories": [ "permissions", "api" ], "example": "add_filter( 'gravityflow_rest_api_capability_process_step', function($capability, $request) {\n // Modify $capability as needed\n return $capability;\n}, 10, 2 );", "since": "[3.0.0](../../since/3-0-0/)", "source": { "file": "includes/rest-api/v2/controllers/class-controller-steps.php", "line": 394 }, "url": "/docs/gravityflow/filters/gravityflow_rest_api_capability_process_step/", "related": [] }, { "id": "gravityflow_rest_api_capability_reports", "name": "gravityflow_rest_api_capability_reports", "type": "filter", "product": "gravityflow", "description": "Filters the capability required to view reports via the REST API.", "parameters": [ { "name": "capability", "type": "string\\", "description": "array`" }, { "name": "request", "type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)", "description": "Full data about the request." } ], "categories": [ "permissions", "api" ], "example": "add_filter( 'gravityflow_rest_api_capability_reports', function($capability, $request) {\n // Modify $capability as needed\n return $capability;\n}, 10, 2 );", "since": "[3.0.0](../../since/3-0-0/)", "source": { "file": "includes/blocks/endpoints/reports/class-endpoint.php", "line": 36 }, "url": "/docs/gravityflow/filters/gravityflow_rest_api_capability_reports/", "related": [] }, { "id": "gravityflow_rest_api_capability_restart_step", "name": "gravityflow_rest_api_capability_restart_step", "type": "filter", "product": "gravityflow", "description": "Filters the capability required to restart a step via the REST API.", "parameters": [ { "name": "capability", "type": "string\\", "description": "array`" }, { "name": "request", "type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)", "description": "Full data about the request." } ], "categories": [ "permissions", "api" ], "example": "add_filter( 'gravityflow_rest_api_capability_restart_step', function($capability, $request) {\n // Modify $capability as needed\n return $capability;\n}, 10, 2 );", "since": "[3.0.0](../../since/3-0-0/)", "source": { "file": "includes/rest-api/v2/controllers/class-controller-steps.php", "line": 255 }, "url": "/docs/gravityflow/filters/gravityflow_rest_api_capability_restart_step/", "related": [] }, { "id": "gravityflow_rest_api_capability_restart_workflow", "name": "gravityflow_rest_api_capability_restart_workflow", "type": "filter", "product": "gravityflow", "description": "Filters the capability required to restart a workflow via the REST API.", "parameters": [ { "name": "capability", "type": "string\\", "description": "array`" }, { "name": "request", "type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)", "description": "Full data about the request." } ], "categories": [ "permissions", "api" ], "example": "add_filter( 'gravityflow_rest_api_capability_restart_workflow', function($capability, $request) {\n // Modify $capability as needed\n return $capability;\n}, 10, 2 );", "since": "[3.0.0](../../since/3-0-0/)", "source": { "file": "includes/rest-api/v2/controllers/class-controller-workflows.php", "line": 164 }, "url": "/docs/gravityflow/filters/gravityflow_rest_api_capability_restart_workflow/", "related": [] }, { "id": "gravityflow_rest_api_capability_send_step", "name": "gravityflow_rest_api_capability_send_step", "type": "filter", "product": "gravityflow", "description": "Filters the capability required to send a step via the REST API.", "parameters": [ { "name": "capability", "type": "string\\", "description": "array`" }, { "name": "request", "type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)", "description": "Full data about the request." } ], "categories": [ "permissions", "api" ], "example": "add_filter( 'gravityflow_rest_api_capability_send_step', function($capability, $request) {\n // Modify $capability as needed\n return $capability;\n}, 10, 2 );", "since": "[3.0.0](../../since/3-0-0/)", "source": { "file": "includes/rest-api/v2/controllers/class-controller-steps.php", "line": 319 }, "url": "/docs/gravityflow/filters/gravityflow_rest_api_capability_send_step/", "related": [] }, { "id": "gravityflow_rest_api_capability_workflow_status", "name": "gravityflow_rest_api_capability_workflow_status", "type": "filter", "product": "gravityflow", "description": "Filters the capability required to view a workflow status via the REST API.", "parameters": [ { "name": "capability", "type": "string\\", "description": "array`" }, { "name": "request", "type": "[\\WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)", "description": "Full data about the request." } ], "categories": [ "permissions", "api" ], "example": "add_filter( 'gravityflow_rest_api_capability_workflow_status', function($capability, $request) {\n // Modify $capability as needed\n return $capability;\n}, 10, 2 );", "since": "[3.0.0](../../since/3-0-0/)", "source": { "file": "includes/rest-api/v2/controllers/class-controller-workflows.php", "line": 109 }, "url": "/docs/gravityflow/filters/gravityflow_rest_api_capability_workflow_status/", "related": [] }, { "id": "gravityflow_reverse_comment_order_discussion_field", "name": "gravityflow_reverse_comment_order_discussion_field", "type": "filter", "product": "gravityflow", "description": "Allow the order of the discussion field comments to be reversed.", "parameters": [ { "name": "reverse_comment_order", "type": "bool", "description": "Should the comment order be reversed? Default is false." }, { "name": "this", "type": "\\Gravity_Flow_Field_Discussion", "description": "The field currently being processed." }, { "name": "format", "type": "string", "description": "The requested format for the value; html or text." } ], "categories": [ "fields" ], "example": "add_filter( 'gravityflow_reverse_comment_order_discussion_field', function($reverse_comment_order, $this, $format) {\n // Modify $reverse_comment_order as needed\n return $reverse_comment_order;\n}, 10, 3 );", "since": "[1.4.2](../../since/1-4-2/)-dev", "source": { "file": "includes/fields/class-field-discussion.php", "line": 246 }, "url": "/docs/gravityflow/filters/gravityflow_reverse_comment_order_discussion_field/", "related": [] }, { "id": "gravityflow_revert_label_workflow_detail", "name": "gravityflow_revert_label_workflow_detail", "type": "filter", "product": "gravityflow", "description": "Allows the 'Revert' label to be modified on the Approval step.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_revert_label_workflow_detail', function() {\n // Modify $value as needed\n return $value;\n} );", "since": null, "source": { "file": "includes/steps/class-step-approval.php", "line": 1023 }, "url": "/docs/gravityflow/filters/gravityflow_revert_label_workflow_detail/", "related": [] }, { "id": "gravityflow_sanitize_instructions", "name": "gravityflow_sanitize_instructions", "type": "filter", "product": "gravityflow", "description": "Allows sanitization to be turned on or off for the instructions.", "parameters": [ { "name": "sanitize_instructions", "type": "bool", "description": "Whether to sanitize the confirmation message. default: false" } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_sanitize_instructions', function($sanitize_instructions) {\n // Modify $sanitize_instructions as needed\n return $sanitize_instructions;\n}, 10, 1 );", "since": "[1.6.2](../../since/1-6-2/)", "source": { "file": "includes/pages/class-entry-detail.php", "line": 507 }, "url": "/docs/gravityflow/filters/gravityflow_sanitize_instructions/", "related": [] }, { "id": "gravityflow_save_progress_button_text_user_input", "name": "gravityflow_save_progress_button_text_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the save_progress button label to be modified on the User Input step when the Save Progress option is set to 'Submit Buttons'.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_save_progress_button_text_user_input', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[1.9.2](../../since/1-9-2/)", "source": { "file": "includes/steps/class-step-user-input.php", "line": 735 }, "url": "/docs/gravityflow/filters/gravityflow_save_progress_button_text_user_input/", "related": [] }, { "id": "gravityflow_save_progress_button_user_input", "name": "gravityflow_save_progress_button_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the save_progress button to be modified on the User Input step when the Save Progress option is set to 'Submit Buttons'.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_save_progress_button_user_input', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[1.9.2](../../since/1-9-2/)", "source": { "file": "includes/steps/class-step-user-input.php", "line": 746 }, "url": "/docs/gravityflow/filters/gravityflow_save_progress_button_user_input/", "related": [] }, { "id": "gravityflow_search_criteria_status", "name": "gravityflow_search_criteria_status", "type": "filter", "product": "gravityflow", "description": "Allows search_criteria to be adjusted to define which forms' entries are displayed in status table.", "parameters": [ { "name": "search_criteria", "type": "array", "description": "The search criteria" } ], "categories": [ "search" ], "example": "add_filter( 'gravityflow_search_criteria_status', function($search_criteria) {\n // Modify $search_criteria as needed\n return $search_criteria;\n}, 10, 1 );", "since": "[2.5](../../since/2-5/)", "source": { "file": "includes/pages/class-status.php", "line": 1748 }, "url": "/docs/gravityflow/filters/gravityflow_search_criteria_status/", "related": [] }, { "id": "gravityflow_send_to_step_condition_met_required", "name": "gravityflow_send_to_step_condition_met_required", "type": "filter", "product": "gravityflow", "description": "Confirms whether the step conditions being met is required to send a workflow to a specific step.", "parameters": [ { "name": "conditions_met_required", "type": "bool", "description": "Whether to pass a workflow to a step that has failed its required conditions." }, { "name": "new_step", "type": "\\Gravity_Flow_Step", "description": "The proposed new step that failed its step conditions." }, { "name": "current_step", "type": "\\Gravity_Flow_Step", "description": "The current step." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "form", "type": "array", "description": "The current form." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_send_to_step_condition_met_required', function($conditions_met_required, $new_step, $current_step, $entry, $form) {\n // Modify $conditions_met_required as needed\n return $conditions_met_required;\n}, 10, 5 );", "since": "[2.5.10](../../since/2-5-10/)", "source": { "file": "includes/class-api.php", "line": 251 }, "url": "/docs/gravityflow/filters/gravityflow_send_to_step_condition_met_required/", "related": [] }, { "id": "gravityflow_send_to_step_condition_not_met", "name": "gravityflow_send_to_step_condition_not_met", "type": "filter", "product": "gravityflow", "description": "Determines what next step a workflow should proceed to instead of the selected step that failed its step conditions.", "parameters": [ { "name": "next_step", "type": "bool\\", "description": "\\Gravity_Flow_Step`" }, { "name": "new_step", "type": "\\Gravity_Flow_Step", "description": "The proposed new step that failed its step conditions." }, { "name": "current_step", "type": "\\Gravity_Flow_Step", "description": "The current step." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "form", "type": "array", "description": "The current form." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_send_to_step_condition_not_met', function($next_step, $new_step, $current_step, $entry, $form) {\n // Modify $next_step as needed\n return $next_step;\n}, 10, 5 );", "since": "[2.5.10](../../since/2-5-10/)", "source": { "file": "includes/class-api.php", "line": 293 }, "url": "/docs/gravityflow/filters/gravityflow_send_to_step_condition_not_met/", "related": [] }, { "id": "gravityflow_shortcode_.apage", "name": "gravityflow_shortcode_ . $a[page]", "type": "filter", "product": "gravityflow", "description": "Allows the gravityflow shortcode to be modified and supports custom pages.", "parameters": [ { "name": "html", "type": "string", "description": "The HTML." }, { "name": "atts", "type": "array", "description": "The original shortcode attributes." }, { "name": "content", "type": "string", "description": "The content inside the shortcode block." } ], "categories": [ "shortcodes" ], "example": "add_filter( 'gravityflow_shortcode_ . $a[page]', function($html, $atts, $content) {\n // Modify $html as needed\n return $html;\n}, 10, 3 );", "since": null, "source": { "file": "class-gravity-flow.php", "line": 6187 }, "url": "/docs/gravityflow/filters/gravityflow_shortcode_.apage/", "related": [] }, { "id": "gravityflow_site_cookie_path", "name": "gravityflow_site_cookie_path", "type": "filter", "product": "gravityflow", "description": "Allow the site cookie path to be overridden.", "parameters": [ { "name": "site_cookie_path", "type": "string", "description": "The site cookie path." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_site_cookie_path', function($site_cookie_path) {\n // Modify $site_cookie_path as needed\n return $site_cookie_path;\n}, 10, 1 );", "since": "[1.9.2](../../since/1-9-2/)-dev", "source": { "file": "class-gravity-flow.php", "line": 8852 }, "url": "/docs/gravityflow/filters/gravityflow_site_cookie_path/", "related": [] }, { "id": "gravityflow_sort_columns_status_table", "name": "gravityflow_sort_columns_status_table", "type": "filter", "product": "gravityflow", "description": "Allows the sortability of columns to be filtered for the status table.", "parameters": [ { "name": "columns", "type": "array", "description": "The columns to be sorted" }, { "name": "this", "type": "\\WP_List_Table", "description": "The current WP_List_Table object." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_sort_columns_status_table', function($columns, $this) {\n // Modify $columns as needed\n return $columns;\n}, 10, 2 );", "since": "[2.6.1](../../since/2-6-1/)", "source": { "file": "includes/pages/class-status.php", "line": 1245 }, "url": "/docs/gravityflow/filters/gravityflow_sort_columns_status_table/", "related": [] }, { "id": "gravityflow_sort_criteria_status", "name": "gravityflow_sort_criteria_status", "type": "filter", "product": "gravityflow", "description": "Allows sorting to be adjusted to define which order entries are displayed in status table.", "parameters": [ { "name": "sorting", "type": "array", "description": "The sorting criteria" } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_sort_criteria_status', function($sorting) {\n // Modify $sorting as needed\n return $sorting;\n}, 10, 1 );", "since": "[2.6.1](../../since/2-6-1/)", "source": { "file": "includes/pages/class-status.php", "line": 1784 }, "url": "/docs/gravityflow/filters/gravityflow_sort_criteria_status/", "related": [] }, { "id": "gravityflow_status_args", "name": "gravityflow_status_args", "type": "filter", "product": "gravityflow", "description": "Allow the status page/export arguments to be overridden.", "parameters": [ { "name": "args", "type": "array", "description": "The status page and export arguments." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_status_args', function($args) {\n // Modify $args as needed\n return $args;\n}, 10, 1 );", "since": null, "source": { "file": "includes/pages/class-status.php", "line": 43 }, "url": "/docs/gravityflow/filters/gravityflow_status_args/", "related": [] }, { "id": "gravityflow_status_submitter_name", "name": "gravityflow_status_submitter_name", "type": "filter", "product": "gravityflow", "description": "Allow the value displayed in the Submitter column to be overridden.", "parameters": [ { "name": "label", "type": "string", "description": "The display_name of the logged-in user who submitted the form or the guest ip address." }, { "name": "item", "type": "array", "description": "The entry object for the row currently being processed." }, { "name": "form", "type": "array", "description": "The form object for the current entry." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_status_submitter_name', function($label, $item, $form) {\n // Modify $label as needed\n return $label;\n}, 10, 3 );", "since": null, "source": { "file": "includes/pages/class-status.php", "line": 962 }, "url": "/docs/gravityflow/filters/gravityflow_status_submitter_name/", "related": [] }, { "id": "gravityflow_step_assignees", "name": "gravityflow_step_assignees", "type": "filter", "product": "gravityflow", "description": "Allows the assignees to be modified for the step.", "parameters": [ { "name": "this->_assignees", "type": "\\Gravity_Flow_Assignee[]", "description": "The array of Assignees." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_step_assignees', function($this->_assignees, $this) {\n // Modify $this->_assignees as needed\n return $this->_assignees;\n}, 10, 2 );", "since": "[1.8.1](../../since/1-8-1/)", "source": { "file": "includes/steps/class-step.php", "line": 1588 }, "url": "/docs/gravityflow/filters/gravityflow_step_assignees/", "related": [] }, { "id": "gravityflow_step_column_status_page", "name": "gravityflow_step_column_status_page", "type": "filter", "product": "gravityflow", "description": "Allow the value in the step column on the status page to be modified.", "parameters": [ { "name": "output", "type": "string", "description": "The column value to be output." }, { "name": "item", "type": "array", "description": "The Entry." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_step_column_status_page', function($output, $item) {\n // Modify $output as needed\n return $output;\n}, 10, 2 );", "since": null, "source": { "file": "includes/pages/class-status.php", "line": 1052 }, "url": "/docs/gravityflow/filters/gravityflow_step_column_status_page/", "related": [] }, { "id": "gravityflow_step_due_date_timestamp", "name": "gravityflow_step_due_date_timestamp", "type": "filter", "product": "gravityflow", "description": "Allows the due date timestamp to be overridden.", "parameters": [ { "name": "due_date_timestamp", "type": "int", "description": "The current expiration timestamp (UTC)." }, { "name": "expiration_type", "type": "string", "description": "The type of expiration defined in step settings." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_step_due_date_timestamp', function($due_date_timestamp, $expiration_type, $this) {\n // Modify $due_date_timestamp as needed\n return $due_date_timestamp;\n}, 10, 3 );", "since": "[2.5](../../since/2-5/)", "source": { "file": "includes/steps/class-step.php", "line": 806 }, "url": "/docs/gravityflow/filters/gravityflow_step_due_date_timestamp/", "related": [] }, { "id": "gravityflow_step_expiration_timestamp", "name": "gravityflow_step_expiration_timestamp", "type": "filter", "product": "gravityflow", "description": "Allows the expiration timestamp to be overridden.", "parameters": [ { "name": "expiration_timestamp", "type": "int", "description": "The current expiration timestamp (UTC)." }, { "name": "expiration_type", "type": "string", "description": "The type of expiration defined in step settings." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_step_expiration_timestamp', function($expiration_timestamp, $expiration_type, $this) {\n // Modify $expiration_timestamp as needed\n return $expiration_timestamp;\n}, 10, 3 );", "since": "[2.3.2](../../since/2-3-2/)", "source": { "file": "includes/steps/class-step.php", "line": 847 }, "url": "/docs/gravityflow/filters/gravityflow_step_expiration_timestamp/", "related": [] }, { "id": "gravityflow_step_highlight_color_inbox", "name": "gravityflow_step_highlight_color_inbox", "type": "filter", "product": "gravityflow", "description": "Allow the Step Highlight colour to be overridden.", "parameters": [ { "name": "step_highlight_color", "type": "string", "description": "The highlight color (hex value) of the row currently being processed." }, { "name": "form", "type": "int", "description": "['id'] The ID of form currently being processed." }, { "name": "entry", "type": "array", "description": "The entry object for the row currently being processed." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_step_highlight_color_inbox', function($step_highlight_color, $form, $entry) {\n // Modify $step_highlight_color as needed\n return $step_highlight_color;\n}, 10, 3 );", "since": "[1.9.2](../../since/1-9-2/)", "source": { "file": "includes/inbox/models/class-task.php", "line": 414 }, "url": "/docs/gravityflow/filters/gravityflow_step_highlight_color_inbox/", "related": [] }, { "id": "gravityflow_step_is_condition_met", "name": "gravityflow_step_is_condition_met", "type": "filter", "product": "gravityflow", "description": "Allows the determination for step conditions being met to be customized.", "parameters": [ { "name": "condition_met", "type": "bool", "description": "Are the step condition(s) met." }, { "name": "logic", "type": "array", "description": "The conditional logic to be evaluated." }, { "name": "form", "type": "array", "description": "The current form." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_step_is_condition_met', function($condition_met, $logic, $form, $entry, $step) {\n // Modify $condition_met as needed\n return $condition_met;\n}, 10, 5 );", "since": "[2.5.6](../../since/2-5-6/)", "source": { "file": "includes/steps/class-step.php", "line": 1462 }, "url": "/docs/gravityflow/filters/gravityflow_step_is_condition_met/", "related": [] }, { "id": "gravityflow_step_notification_assignees", "name": "gravityflow_step_notification_assignees", "type": "filter", "product": "gravityflow", "description": "Allows the assignees for a notification to be customized.", "parameters": [ { "name": "assignees", "type": "\\Gravity_Flow_Assignee[]", "description": "The array of Assignees." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "notifications" ], "example": "add_filter( 'gravityflow_step_notification_assignees', function($assignees, $step) {\n // Modify $assignees as needed\n return $assignees;\n}, 10, 2 );", "since": "[2.9](../../since/2-9/)", "source": { "file": "includes/steps/class-step.php", "line": 1120 }, "url": "/docs/gravityflow/filters/gravityflow_step_notification_assignees/", "related": [] }, { "id": "gravityflow_step_schedule_timestamp", "name": "gravityflow_step_schedule_timestamp", "type": "filter", "product": "gravityflow", "description": "Allows the scheduled date/timestamp to be custom defined.", "parameters": [ { "name": "schedule_timestamp", "type": "int", "description": "The current scheduled timestamp (UTC)" }, { "name": "schedule_type", "type": "string", "description": "The type of schedule defined in step settings." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_step_schedule_timestamp', function($schedule_timestamp, $schedule_type, $this) {\n // Modify $schedule_timestamp as needed\n return $schedule_timestamp;\n}, 10, 3 );", "since": "[2.0.2](../../since/2-0-2/)-dev", "source": { "file": "includes/steps/class-step.php", "line": 728 }, "url": "/docs/gravityflow/filters/gravityflow_step_schedule_timestamp/", "related": [] }, { "id": "gravityflow_step_settings_fields", "name": "gravityflow_step_settings_fields", "type": "filter", "product": "gravityflow", "description": "Allows the step settings to be modified.", "parameters": [ { "name": "settings", "type": "array", "description": "The settings for a step." }, { "name": "current_step_id", "type": "int", "description": "The current step ID or 0 for new step." } ], "categories": [ "fields" ], "example": "add_filter( 'gravityflow_step_settings_fields', function($settings, $current_step_id) {\n // Modify $settings as needed\n return $settings;\n}, 10, 2 );", "since": "[2.8.6](../../since/2-8-6/)", "source": { "file": "class-gravity-flow.php", "line": 2306 }, "url": "/docs/gravityflow/filters/gravityflow_step_settings_fields/", "related": [] }, { "id": "gravityflow_step_status_evaluation_approval", "name": "gravityflow_step_status_evaluation_approval", "type": "filter", "product": "gravityflow", "description": "Allows the step status for the approval to be customized", "parameters": [ { "name": "step_status", "type": "string", "description": "The status of the step" }, { "name": "approvers", "type": "\\Gravity_Flow_Assignee[]", "description": "The array of Gravity_Flow_Assignee objects" }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The current step" } ], "categories": [ "approval" ], "example": "add_filter( 'gravityflow_step_status_evaluation_approval', function($step_status, $approvers, $step) {\n // Modify $step_status as needed\n return $step_status;\n}, 10, 3 );", "since": "[2.1](../../since/2-1/)-dev", "source": { "file": "includes/steps/class-step-approval.php", "line": 485 }, "url": "/docs/gravityflow/filters/gravityflow_step_status_evaluation_approval/", "related": [] }, { "id": "gravityflow_step_status_webhook", "name": "gravityflow_step_status_webhook", "type": "filter", "product": "gravityflow", "description": "Allow the step status to be modified on the webhook step.", "parameters": [ { "name": "step_status", "type": "string", "description": "The step status derived from webhook response." }, { "name": "response", "type": "array", "description": "The response returned from webhook." }, { "name": "args", "type": "array", "description": "The arguments used for executing the webhook request." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "this", "type": "\\Gravity_Flow_Step", "description": "The current step." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_step_status_webhook', function($step_status, $response, $args, $entry, $this) {\n // Modify $step_status as needed\n return $step_status;\n}, 10, 5 );", "since": null, "source": { "file": "includes/steps/class-step-webhook.php", "line": 880 }, "url": "/docs/gravityflow/filters/gravityflow_step_status_webhook/", "related": [] }, { "id": "gravityflow_submit_button_text_user_input", "name": "gravityflow_submit_button_text_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the submit button label to be modified on the User Input step when the Save Progress option is set to 'Submit Buttons'.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_submit_button_text_user_input', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[1.9.2](../../since/1-9-2/)", "source": { "file": "includes/steps/class-step-user-input.php", "line": 759 }, "url": "/docs/gravityflow/filters/gravityflow_submit_button_text_user_input/", "related": [] }, { "id": "gravityflow_submit_button_user_input", "name": "gravityflow_submit_button_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the submit button to be modified on the User Input step when the Save Progress option is set to 'Submit Buttons'", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_submit_button_user_input', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[1.9.2](../../since/1-9-2/)", "source": { "file": "includes/steps/class-step-user-input.php", "line": 770 }, "url": "/docs/gravityflow/filters/gravityflow_submit_button_user_input/", "related": [] }, { "id": "gravityflow_this-get_type_form", "name": "gravityflow_\\{$this->get_type()\\}_form", "type": "filter", "product": "gravityflow", "description": "Allows the form to be modified before it is processed.", "parameters": [ { "name": "form", "type": "array", "description": "The form to be processed." }, { "name": "entry", "type": "array", "description": "The entry being processed." }, { "name": "step", "type": "\\Gravity_Flow_Step", "description": "The step being processed." } ], "categories": [ "forms" ], "example": "add_filter( 'gravityflow_\\{$this->get_type()\\}_form', function($form, $entry, $step) {\n // Modify $form as needed\n return $form;\n}, 10, 3 );", "since": "[2.7.5](../../since/2-7-5/)", "source": { "file": "includes/steps/class-step.php", "line": 410 }, "url": "/docs/gravityflow/filters/gravityflow_this-get_type_form/", "related": [] }, { "id": "gravityflow_timeline_notes", "name": "gravityflow_timeline_notes", "type": "filter", "product": "gravityflow", "description": "Allows the timeline notes to be modified.", "parameters": [ { "name": "notes", "type": "array", "description": "The notes for timeline of current entry." }, { "name": "entry", "type": "array", "description": "The current entry." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_timeline_notes', function($notes, $entry) {\n // Modify $notes as needed\n return $notes;\n}, 10, 2 );", "since": "[2.5.8](../../since/2-5-8/)", "source": { "file": "includes/class-common.php", "line": 334 }, "url": "/docs/gravityflow/filters/gravityflow_timeline_notes/", "related": [] }, { "id": "gravityflow_timeline_step_icon", "name": "gravityflow_timeline_step_icon", "type": "filter", "product": "gravityflow", "description": "Allows the step icon to be filtered for the timeline.", "parameters": [ { "name": "step_icon", "type": "string", "description": "The step icon HTML or image URL." }, { "name": "step", "type": "\\Gravity_Flow_Step\\", "description": "bool`" } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_timeline_step_icon', function($step_icon, $step) {\n // Modify $step_icon as needed\n return $step_icon;\n}, 10, 2 );", "since": null, "source": { "file": "includes/pages/class-entry-detail.php", "line": 655 }, "url": "/docs/gravityflow/filters/gravityflow_timeline_step_icon/", "related": [] }, { "id": "gravityflow_update_button_text_user_input", "name": "gravityflow_update_button_text_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the update button label to be modified on the User Input step when the Save Progress option is set to hidden or either radio button setting.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_update_button_text_user_input', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "unknown: unknown", "source": { "file": "includes/steps/class-step-user-input.php", "line": 784 }, "url": "/docs/gravityflow/filters/gravityflow_update_button_text_user_input/", "related": [] }, { "id": "gravityflow_update_button_user_input", "name": "gravityflow_update_button_user_input", "type": "filter", "product": "gravityflow", "description": "Allows the update button to be modified on the User Input step when the Save Progress option is set to hidden or either radio button setting.", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_update_button_user_input', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "unknown: unknown", "source": { "file": "includes/steps/class-step-user-input.php", "line": 797 }, "url": "/docs/gravityflow/filters/gravityflow_update_button_user_input/", "related": [] }, { "id": "gravityflow_user_input_by_view_edit", "name": "gravityflow_user_input_by_view_edit", "type": "filter", "product": "gravityflow", "description": "Allows a GravityView edit to trigger completion of assignee's user input step. Default true/false is based on Workflow > Settings > Advanced > GravityView Integrations setting.", "parameters": [ { "name": "bool", "type": "array", "description": "Whether to trigger the User Input step for the matching assignee." }, { "name": "entry", "type": "array", "description": "The current entry." }, { "name": "form", "type": "array", "description": "The current form." }, { "name": "current_step", "type": "\\Gravity_Flow_Step", "description": "The current step for this entry." }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The current assignee." } ], "categories": [ "editing", "views" ], "example": "add_filter( 'gravityflow_user_input_by_view_edit', function($bool, $entry, $form, $current_step, $assignee) {\n // Modify $bool as needed\n return $bool;\n}, 10, 5 );", "since": "[2.7.7](../../since/2-7-7/)", "source": { "file": "includes/integrations/gravityview-hooks.php", "line": 259 }, "url": "/docs/gravityflow/filters/gravityflow_user_input_by_view_edit/", "related": [] }, { "id": "gravityflow_webhook_url_in_note", "name": "gravityflow_webhook_url_in_note", "type": "filter", "product": "gravityflow", "description": ":::info[Dynamic Hook Name]", "parameters": [], "categories": [ "general" ], "example": "add_filter( 'gravityflow_webhook_url_in_note', function() {\n // Modify $value as needed\n return $value;\n} );", "since": "[2.3.1](../../since/2-3-1/)", "source": { "file": "includes/steps/class-step-webhook.php", "line": 907 }, "url": "/docs/gravityflow/filters/gravityflow_webhook_url_in_note/", "related": [] }, { "id": "gravityflow_workflow_url", "name": "gravityflow_workflow_url", "type": "filter", "product": "gravityflow", "description": "Allows the workflow URL (e.g. inbox or status page) to be modified.", "parameters": [ { "name": "url", "type": "string", "description": "The URL." }, { "name": "page_id", "type": "int\\", "description": "null`" }, { "name": "assignee", "type": "\\Gravity_Flow_Assignee", "description": "The Assignee." } ], "categories": [ "general" ], "example": "add_filter( 'gravityflow_workflow_url', function($url, $page_id, $assignee) {\n // Modify $url as needed\n return $url;\n}, 10, 3 );", "since": "[1.9.2](../../since/1-9-2/)", "source": { "file": "includes/class-common.php", "line": 72 }, "url": "/docs/gravityflow/filters/gravityflow_workflow_url/", "related": [] } ], "stats": { "total": 121, "actions": 13, "filters": 108 } }