Developers
Gravity Flow Actions and Filters
Understand what hooks Gravity Flow provides, which parameters are available to them and examples of how they can be used to customize the default plugin behaviour to suit your use case / needs.
Extension Actions and Filters
Understand what hooks each Gravity Flow extension provides, which parameters are available to them and how they can be used to customize the default behaviours to suit your use case / needs.
REST API V2
This section of documentation lists articles related to the REST API v2 for Gravity Flow.
REST API V1
This section of documentation lists articles related to the REST API v1 for Gravity Flow.
Class Objects
Reference for the main PHP classes that power Gravity Flow. Each entry describes the class purpose, available methods and properties, and how developers can extend or override behavior.
Data Objects
Articles
gravityflow_step_assignees
The gravityflow_step_assignees filter allows for the assignees of a step to be filtered.
Developing with Gravity Flow
Gravity Flow was written to make it as easy as possible for developers to interact with installations and extend the base functionality.
The Workflow Orchestration API
The Workflow Orchestration API provided by the Gravity_Flow_API class is the starting point for interaction with a local installation.
gravityflow_inbox_fields
The gravityflow_inbox_fields filter is used to customize the field columns displayed in the inbox page in the admin UI (use the block settings or shortcode parameters to do the same in front-end).
The Workflow Web/REST API
The following endpoints are currently available for the Gravity Flow Web/REST API v2 and v1.
gravityflow_columns_status_table
The gravityflow_columns_status_table filter allows the columns to be modified for the status page.
gravityflowdiscussion_display_name_discussion_field
The gravityflowdiscussion_display_name_discussion_field is used to customize the display name for discussion field values.
gravityflow_get_users_args
The filter allows to increase the default number of users returned in the user query that defaults to 1000.
gravityflow_assignee_status_workflow_detail
The gravityflow_assignee_status_workflow_detail filter allows the assignee status label to be modified before rendering.
gravityflow_search_criteria_status
The gravityflow_search_criteria_status is used to allow search_criteria to be adjusted for which entries are displayed in the status table.