php8.5
Home/ Manual/ mysqli / mysqli/ mysqli::ping

mysqli::ping

PHP function Deprecated as of PHP 8.4.0 Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Pings a server connection, or tries to reconnect if the connection has gone down

Function-8-4-0

Description

Oop

mysqli::ping(): bool

Procedural

mysqli_ping(mysqli $mysql): bool

Checks whether the connection to the server is working. If it has gone down and global option mysqli.reconnect is enabled, an automatic reconnection is attempted.

Note

The 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

Return Values

Success

Errors/Exceptions Conditionalexception

Changelog

VersionDescription
8.4.0Both mysqli::ping and mysqli_ping() are now deprecated. As of PHP 8.2.0, the reconnect feature is no longer available, making this function obsolete.

Examples

mysqli::ping example

Oop

php
<?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();
?>

Procedural

php
<?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);
?>

Outputs

output
Our connection is ok!

Source: reference/mysqli/mysqli/ping.xml · from the official PHP manual (php/doc-en)