Managing Notes with the GFAPI

• Introduction
• get_notes
• Method Overview
• Source Code
• Parameters
• Search Arguments
• Sorting Arguments
• Returns
• Usage Example
• Getting all notes for the specified entry
• get_note
• Method Overview
• Source Code
• Parameters
• Returns
• Usage Example
• add_note
• Method Overview
• Source Code
• Parameters
• Sub Type Values
• Returns
• Usage Example
• Adding a user note
• Adding a Success note for a Notification
• delete_note
• Method Overview
• Source Code
• Parameters
• Returns
• Usage Example
• update_note
• Method Overview
• Source Code
• Parameters
• Note Properties
• Returns
• Usage Example
• Updating the note content

Introduction

The GFAPI methods for managing notes were added in Gravity Forms 2.4.18.

See the GFAPI article for other available methods.

get_notes

Returns the notes for the given search criteria.

Method Overview

Source Code

public static function get_notes( $search_criteria = array(), $sorting = null ) {}

Parameters

Search Arguments

An associative array supporting the following properties.

Sorting Arguments

An optional associative array supporting the following properties.

Returns

• $result bool|array
  False, or an array of note objects containing the gf_entry_notes database table columns as properties, plus user_email. user_name is the user’s display name when that user exists.

Usage Example

Getting all notes for the specified entry

$search_criteria = array( 'entry_id' => $entry_id );
$result = GFAPI::get_notes( $search_criteria );

get_note

Returns the specified note.

Method Overview

Source Code

public static function get_note( $note_id ) {}

Parameters

Returns

• $result WP_Error|object
  A WP_Error if the note was not found, or the note object containing the gf_entry_notes database table columns as properties, plus user_email.

Usage Example

$result = GFAPI::get_note( $note_id );

add_note

Adds a note to the specified entry.

Method Overview

Source Code

public static function add_note( $entry_id, $user_id, $user_name, $note, $note_type = 'user', $sub_type = null ) {}

Parameters

Sub Type Values

Any string up to 50 characters is accepted. sub_type is not a fixed list. Third-party add-ons can also add their own values. The entry detail screen applies built-in styling to the following values.

Any other value is stored and shown with the default note styling. On the entry detail screen, the note content is given the class gforms_note_{sub_type}, which can be used to style a custom value.

Returns

• $result WP_Error|int
  A WP_Error if an error occurs, or the ID of the note returned by the database upon success.

Usage Example

Adding a user note

$result = GFAPI::add_note( $entry_id, $user_id, $user_name, 'this is a test note' );

Adding a Success note for a Notification

$result = GFAPI::add_note( $entry_id, $user_id, $user_name, 'This is a success note for Notification', 'notification', 'success' );

delete_note

Deletes the specified note.

Method Overview

Source Code

public static function delete_note( $note_id ) {}

Parameters

Returns

• $result WP_Error|int
  A WP_Error if the note does not exist, or the number of rows deleted on success.

Usage Example

$result = GFAPI::delete_note( $note_id );

update_note

Updates the specified note.

Method Overview

Source Code

public static function update_note( $note, $note_id = '' ) {}

Parameters

Note Properties

An associative array supporting the following properties. Omitted properties keep their current values.

Returns

• $result WP_Error|int|bool
  A WP_Error if the note is missing or the input is invalid, the number of rows updated on success, or false if the database update fails.

Usage Example

Updating the note content

$note = array( 'value' => 'the updated note' );
$result = GFAPI::update_note( $note, $note_id );