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

ssh2_sftp_rmdir

PHP function Edit on GitHub ✎

(PECL ssh2 >= 0.9.0)

Remove a directory

Description

ssh2_sftp_rmdir(resource $sftp, string $dirname): bool

Removes a directory from the remote file server.

This function is similar to using rmdir() with the ssh2.sftp:// wrapper.

Parameters

sftp

An SSH2 SFTP resource opened by ssh2_sftp().

dirname

Return Values

Success

Examples

Removing a directory on a remote server

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

ssh2_sftp_rmdir($sftp, '/home/username/deltodel');
/* Or:  rmdir("ssh2.sftp://$sftp/home/username/dirtodel"); */
?>

See Also

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