PHP | mysqli_stmt_get_result() Function

PHP mysqli_stmt_get_result() 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_stmt_get_result() Function.

The built-in PHP mysqli_stmt_get_result() function accepts a statement object as a parameter, retrieves the result set from the given statement (if there are any) and then returns it.

You cannot close persistent connections using this PHP function.

Syntax

Following below is the syntax to use this function -

mysqli_stmt_get_result($stmt);


Parameter Details

Sr.NoParameter & Description
1

stmt(Mandatory)

This is an object representing the prepared statement.


Return Value

This built-in PHP function returns a result set if the statement executed is SELECT and if it is successful, otherwise this built-in PHP function returns FALSE.

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_stmt_get_result() 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')");
   print("Record Inserted.....\n");

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

   //Executing the statement
   mysqli_stmt_execute($stmt);

   //Getting the result
   $res = mysqli_stmt_get_result($stmt);

   while ($row = mysqli_fetch_array($res, MYSQLI_NUM)){
      foreach($row as $r){
         print("$r ");
      }
      print("\n");
   }		
		
   //Closing the statement
   mysqli_stmt_close($stmt);

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

Output

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

Table Created.....
Record Inserted.....
1 Kennedy Nkpara PortHarcourt Nigeria
2 Jonathan Trott CapeTown SouthAfrica

Example2

In an object oriented style the syntax of this function is $stmt->get_result(); 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';
   print("Records Inserted.....\n");

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

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

   print_r($res);

   //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.....
Records Inserted.....
mysqli_result Object
(
    [current_field] => 0
    [field_count] => 2
    [lengths] =>
    [num_rows] => 6
    [type] => 0
)


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_stmt_num_rows() 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.

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.