PHP mysqli_fetch_field() Function

PHP MySQLi Reference PHP MySQLi Reference


Return the next field (column) in the result set, then print each field's name, table, and max length:

// Check connection
if (mysqli_connect_errno())
  echo "Failed to connect to MySQL: " . mysqli_connect_error();

$sql="SELECT Lastname,Age FROM Persons ORDER BY Lastname";

if ($result=mysqli_query($con,$sql))
  // Get field information for all fields
  while ($fieldinfo=mysqli_fetch_field($result))
    printf("Name: %s\n",$fieldinfo->name);
    printf("Table: %s\n",$fieldinfo->table);
    printf("max. Len: %d\n",$fieldinfo->max_length);
  // Free result set


Definition and Usage

The mysqli_fetch_field() function returns the next field (column) in the result set, as an object.



Parameter Description
result Required. Specifies a result set identifier returned by mysqli_query(), mysqli_store_result() or mysqli_use_result()

Technical Details

Return Value: Returns an object containing field definition information. FALSE if no info is available. The object has the following properties:
  • name - name of the column
  • orgname - original column name (if an alias is specified)
  • table - name of table
  • orgtable - original table name (if an alias is specified)
  • def - reserved for default values, currently always ""
  • db - database (new in PHP 5.3.6)
  • catalog - catalog name, always "def" (since PHP 5.3.6)
  • max_length - maximum width of field
  • length - width of field as specified in table definition
  • charsetnr - character set number for the field
  • flags - bit-flags for the field
  • type - data type used for the field
  • decimals - for integer fields; the number of decimals used
PHP Version: 5+

PHP MySQLi Reference PHP MySQLi Reference


Color Picker