Gravity_Forms\Gravity_Forms\Orders\Summaries\GF_Order_Summary
Source: includes/orders/summaries/class-gf-order-summary.php:9
Details
- Kind:
class - Namespace:
Gravity_Forms\Gravity_Forms\Orders\Summaries
Properties
| Property | Type | Description |
|---|---|---|
$configurations | array | Contains any specific configurations for rendering the summary, for example showing only a receipt. |
Methods
| Method | Description |
|---|---|
render() | Renders the summary markup using the provided data and view. |
get_labels() | Return the labels used in the summary view. |
Method Reference
render()
public static function render( $form, $entry, $view='order-summary', $use_choice_text=false, $use_admin_labels=false, $receipt=false )
Renders the summary markup using the provided data and view.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form | array | The form object. | |
$entry | array | The entry object. | |
$view | string | 'order-summary' | The view to be used for rendering the order. |
$use_choice_text | bool | false | If the product field has choices, this decided if the choice text should be retrieved along with the product name or not. |
$use_admin_labels | bool | false | Whether to use the product admin label or the front end label. |
$receipt | bool | false | Whether to show only the line items paid for in the order or all products in the form. |
Returns
string— The summary markup.
Since: 2.6
Source: includes/orders/summaries/class-gf-order-summary.php:34
get_labels()
public static function get_labels( $form )
Return the labels used in the summary view.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form |
Returns
array
Since: 2.6
Source: includes/orders/summaries/class-gf-order-summary.php:59