mysqli::ping
mysqli_ping
Pings a server connection, or tries to reconnect if the connection has gone down
WarningThis function has been
DEPRECATED as of PHP 8.4.0. Relying on this function
is highly discouraged.
Description
Object-oriented style
public bool mysqli::ping()
bool mysqli_ping(mysqli $mysql)
Note:
The php.ini setting mysqli.reconnect is ignored by the mysqlnd driver, so
automatic reconnection is never attempted.
This function can be used by clients that remain idle for a long while,
to check whether the server has closed the connection and reconnect if
necessary.
Parameters
-
mysql
-
Procedural style only: A mysqli object
returned by mysqli_connect or mysqli_init
Return Values
Returns true on success or false on failure.
Errors/Exceptions
If mysqli error reporting is enabled (MYSQLI_REPORT_ERROR) and the requested operation fails,
a warning is generated. If, in addition, the mode is set to MYSQLI_REPORT_STRICT,
a mysqli_sql_exception is thrown instead.
Examples
Example #1 mysqli::ping example
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* check connection */
if ($mysqli->connect_errno) {
printf("Connect failed: %s\n", $mysqli->connect_error);
exit();
}
/* check if server is alive */
if ($mysqli->ping()) {
printf ("Our connection is ok!\n");
} else {
printf ("Error: %s\n", $mysqli->error);
}
/* close connection */
$mysqli->close();
?>
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
/* check if server is alive */
if (mysqli_ping($link)) {
printf ("Our connection is ok!\n");
} else {
printf ("Error: %s\n", mysqli_error($link));
}
/* close connection */
mysqli_close($link);
?>
The above examples will output: