Entry Object

Contents

Introduction

The Entry Object contains all properties of a particular entry (i.e. date created, client IP, submitted field values, etc...). It is formatted as an associative array with field Ids being the key to that field's data.

Usage

$entry["date_created"];   // returns the entry date
$entry["1"];              // returns the value associated with field 1
$entry["1.3"];            // returns the value associated with the first name portion of a simple name field 1
$entry["1.6"];            // returns the value associated with the last name portion of a simple name field 1
$entry["2.4"];            // returns the value associated with the street input for the address field 2

Properties

Standard

  • id
    (int) The entry's Id.
  • form_id
    (int) The ID of the form from which the entry was submitted.
  • created_by
    (int) ID of the user that submitted of the form if a logged in user submitted the form.
  • date_created
    (string) The date and time that the entry was created, in the format "yyyy-mm-dd hh:mi:ss" (i.e. 2010-07-15 17:26:58)
  • is_starred
    (bool) Indicates if the entry has been starred (i.e marked with a star). 1 for entries that are starred and 0 for entries that are not starred.
  • is_read
    (bool) Indicates if the entry has been read. 1 for entries that are read and 0 for entries that have not been read.
  • ip
    (string) Client IP of user who submitted the form.
  • source_url
    (string) Source URL of page that contained the form when it was submitted.
  • post_id
    (int) For forms with Post fields, this property contains the Id of the Post that was created.
  • user_agent
    (string) Provides the name and version of both the browser and operating system from which the entry was submitted.
  • status
    (string) The current status of the entry (ie "Active", "Spam", "Trash").

Pricing Properties

These $entry properties are only relevant when a Gravity Forms payment gateway add-on is being used.

  • currency
    (string) The currency with which the entry was submitted (ie "USD", "EUR").
  • payment_status
    (string) The current payment status of the entry (ie "Processing", "Pending", "Active", "Expired", "Failed", "Cancelled", "Approved", "Reversed", "Refunded", "Voided").
  • payment_date
    (string) The date the payment has been received.
  • payment_amount
    (int) The amount of the fulfilled payment; this property is empty until the payment has been received. Sample value: 75
  • transaction_id
    (string) ID of the transaction returned by the payment gateway
  • is_fulfilled
    (bool) Indicates if the entry/order has been fulfilled. 1 for entries that have been fulfilled and 0 for entries that have not been fulfilled.
  • transaction_type
    (int) Indicates the transaction type of the entry/order. 1 for one time payments, 2 for subscriptions. needs_review

Field Values

  • FIELD_ID
    (string) The value for all submitted fields can be retrieved by using the Field Id as the key to the $entry array.
$entry["1"];              //returns the value associated with field 1
$entry["2.4"];            //returns the value associated with the street input for the address field 2

Search the Documentation