php8.5
Home/ Manual/ ssh2 / functions/ ssh2_sftp_stat

ssh2_sftp_stat

PHP function Edit on GitHub ✎

(PECL ssh2 >= 0.9.0)

Stat a file on a remote filesystem

Description

ssh2_sftp_stat(resource $sftp, string $path): array|false

Stats a file on the remote filesystem following any symbolic links.

This function is similar to using the stat() function with the ssh2.sftp:// wrapper and returns the same values.

Parameters

sftp

An SSH2 SFTP resource opened by ssh2_sftp().

path

Return Values

Returns an array of statistics for the given file on successFalseforfailure. See the documentation for stat() for details on the values which may be returned.

Examples

Stating a file via SFTP

php
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');

$sftp = ssh2_sftp($connection);
$statinfo = ssh2_sftp_stat($sftp, '/path/to/file');

$filesize = $statinfo['size'];
$group = $statinfo['gid'];
$owner = $statinfo['uid'];
$atime = $statinfo['atime'];
$mtime = $statinfo['mtime'];
$mode = $statinfo['mode'];
?>

See Also

Source: reference/ssh2/functions/ssh2-sftp-stat.xml · from the official PHP manual (php/doc-en)