php / 8.1.5 / function.pg-num-fields.html /

pg_num_fields

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

pg_num_fieldsReturns the number of fields in a result

Description

pg_num_fields(PgSql\Result $result): int

pg_num_fields() returns the number of fields (columns) in the PgSql\Result instance.

Note:

This function used to be called pg_numfields().

Parameters

result

An PgSql\Result instance, returned by pg_query(), pg_query_params() or pg_execute()(among others).

Return Values

The number of fields (columns) in the result. On error, -1 is returned.

Changelog

Version Description
8.1.0 The result parameter expects an PgSql\Result instance now; previously, a resource was expected.

Examples

Example #1 pg_num_fields() example

<?php
$result = pg_query($conn, "SELECT 1, 2");

$num = pg_num_fields($result);

echo $num . " field(s) returned.\n";
?>

The above example will output:

2 field(s) returned.

See Also

© 1997–2021 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.pg-num-fields.php