Overview

Classes

  • GF_Background_Upgrader
  • GF_Download
  • GF_Forms_Model_Legacy
  • GF_Query_Call
  • GF_Query_Column
  • GF_Query_Condition
  • GF_Query_Literal
  • GF_Query_Series
  • GF_Upgrade
  • GFAddOn
  • GFAddOnFeedsTable
  • GFAPI
  • GFFeedAddOn
  • GFPaymentAddOn
  • GFPaymentStatsTable
  • Gravity_Api

Functions

  • gapi
  • Overview
  • Class

Class Gravity_Api

Client-side API wrapper for interacting with the Gravity APIs.

Package: Gravity\Api
Since: 1.9
Located at class-gravity-api.php
Methods summary
public static
# get_instance( )
public boolean
# register_current_site( string $license_key, boolean $is_md5 = false )

Retrieves site key and site secret key from remote API and stores them as WP options. Returns false if license key is invalid; otherwise, returns true.

Retrieves site key and site secret key from remote API and stores them as WP options. Returns false if license key is invalid; otherwise, returns true.

Parameters

$license_key
License key to be registered
$is_md5
Specifies if $license_key provided is an MD5 or unhashed license key.

Returns

boolean
Success

Since

2.3
public boolean
# update_current_site( string $new_license_key_md5 )

Updates license key for a site that has already been registered.

Updates license key for a site that has already been registered.

Parameters

$new_license_key_md5
Hash license key to be updated

Returns

boolean
Success

Since

2.3
public
# deregister_current_site( )
public
# prepare_response_body( $raw_response )
public
# purge_site_credentials( )
public
# request( $resource, $body, $method = 'POST', $options = array() )
public
# get_site_key( )
public
# get_site_secret( )
public
# get_gravity_api_url( )
public
# is_site_registered( )
Gravity Forms API API documentation generated by ApiGen