Skip to main content

GF_Query_Column

The Gravity Forms Query Column class.

Source: includes/query/class-gf-query-column.php:6

Details

  • Kind: class
  • Namespace: (global)

Methods

MethodDescription
__construct()Represents a column.
sql()Get some SQL for this column.
is_entry_column()Whether this field is an entry column.
is_nullable_entry_column()Whether this field is a nullable entry column.
is_meta_column()Whether this field is a meta column.
__get()Proxy read-only values.

Method Reference

__construct()

public function __construct( $field_id, $source=0, $alias=false )

Represents a column.

Parameters

NameTypeDefaultDescription
$field_idstringThe field ID (meta key or column name).
$sourceint | array0The source this field is referencing.
$aliasstring | boolfalseAn alias override. Default: false.

Source: includes/query/class-gf-query-column.php:35

sql()

public function sql( $query )

Get some SQL for this column.

Parameters

NameTypeDefaultDescription
$queryGF_Query The query.

Returns

  • string — The SQL.

Source: includes/query/class-gf-query-column.php:52

is_entry_column()

public function is_entry_column()

Whether this field is an entry column.

Returns

  • boolean — An entry column or not.

Source: includes/query/class-gf-query-column.php:75

is_nullable_entry_column()

public function is_nullable_entry_column()

Whether this field is a nullable entry column.

Returns

  • boolean — An entry column or not.

Since: 2.3.1.10

Source: includes/query/class-gf-query-column.php:95

is_meta_column()

public function is_meta_column()

Whether this field is a meta column.

Returns

  • boolean — A meta column or not.

Source: includes/query/class-gf-query-column.php:115

__get()

public function __get( $key )

Proxy read-only values.

Parameters

NameTypeDefaultDescription
$key

Source: includes/query/class-gf-query-column.php:126