PHP | mysqli_field_seek() Function

PHP mysqli_field_seek() Function


Hello folks! welcome back to a new edition of our tutorial on PHP. In this tutorial guide, we are going to be studying about the PHP mysqli_field_seek() Function.

The mysqli_field_seek() function accepts a result object and an integer value which represents a field number, as parameters, and moves the field seek of the given result object to the specified field.

Syntax

Following below is the syntax to use this function -

mysqli_field_seek($result, $field);


Parameter Details

Sr.NoParameter & Description
1

result(Mandatory)

This is an identifier representing a result object.

2

field(Mandatory)

This is an integer value representing a field number to which you need to move the field seek in the given result object.


Return Value

This built-in PHP function returns true on success and false on failure.

PHP Version

This PHP function was first introduced in PHP version 5 and works in all the later versions.

Example1

The following below is an example which demonstrates the usage of the built-in PHP mysqli_field_seek() function (in a procedural style) -

<?php
   $con = mysqli_connect("localhost", "root", "password", "mydb");

   mysqli_query($con, "CREATE TABLE myplayers(ID INT, First_Name VARCHAR(255), Last_Name VARCHAR(255), Place_Of_Birth VARCHAR(255), Country VARCHAR(255))");
   print("Table Created.....\n");
   mysqli_query($con, "INSERT INTO myplayers values(1, 'Kennedy', 'Nkpara', 'PortHarcourt', 'Nigeria')");
   mysqli_query($con, "INSERT INTO myplayers values(2, 'Jonathan', 'Trott', 'CapeTown', 'SouthAfrica')");
   mysqli_query($con, "INSERT INTO myplayers values(3, 'Queen', 'Douglas', 'Texas', 'UnitedStates')");
   print("Record Inserted.....\n");

   //Retrieving the contents of the table
   $res = mysqli_query($con, "SELECT * FROM myplayers");

   //Moving the seek to 3rd field
   mysqli_field_seek($res, 2);

   //Fetching the fields
   $info = mysqli_fetch_field($res);
   //Current field
   $currentfield = mysqli_field_tell($res);
   print("Current Field: ".$currentfield."\n");
   print("Name: ".$info->name."\n");
   print("Table: ".$info->table."\n");
   print("Max Length: ".$info->max_length."\n");
   print("Flags: ".$info->flags."\n");
   print("Type: ".$info->type."\n");


   //Closing the statement
   mysqli_free_result($res);

   //Closing the connection
   mysqli_close($con);
?>

Output

When the above code is executed, it will produce the following result -

Table Created.....
Record Inserted.....
Current Field: 3
Name: Last_Name
Table: myplayers
Max Length: 10
Flags: 0
Type: 253

Example2

In an object oriented style the syntax of this function is $result->field_seek(); Following is the example of this function in an object oriented style -

<?php
   //Creating a connection
   $con = new mysqli("localhost", "root", "password", "mydb");

   $con -> query("CREATE TABLE Test(Name VARCHAR(255), AGE INT)");
   $con -> query("insert into Test values('Kennedy', 27),('Paul', 30),('Justice', 28)");
   print("Table Created.....\n");

   $stmt = $con -> prepare( "SELECT * FROM Test WHERE Name in(?, ?)");
   $stmt -> bind_param("ss", $name1, $name2);
   $name1 = 'Kennedy';
   $name2 = 'Paul';

   //Executing the statement
   $stmt->execute();

   //Retrieving the result
   $result = $stmt->get_result();

   //Moving the seek to the 2nd field
   $result->field_seek(1);

   //Fetching the 2nd field Current Field
   $info = $result->fetch_field();

   $field = $result->current_field;
   print("Current Field: ".$field."\n");
   print("Field Name: ".$info->name."\n");
   print("Field Type: ".$info->type);


   //Closing the statement
   $stmt->close();
 
   //Closing the connection
   $con->close();
?>

Output

When the above code is executed, it will produce the following result -

Table Created.....
Current Field: 2
Field Name: AGE
Field Type: 3


Alright guys! This is where we are going to be rounding up for this tutorial post. In our next tutorial, we are going to be discussing about the PHP mysqli_field_tell() Function.

Do feel free to ask your questions where necessary and we will attend to them as soon as possible. If this tutorial was helpful to you, you can use the share button to share this tutorial.

Do follow us on our various social media handles available and also subscribe to our newsletter to get our tutorial posts delivered directly to your emails.

Thanks for reading and bye for now.