ftp_get_option

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

ftp_get_optionカレントの FTP 接続での種々の実行時動作を取得する

説明

ftp_get_option(FTP\Connection $ftp, int $option): int|bool

この関数は、指定した FTP 接続について option の値を返します。

パラメータ

ftp

FTP\Connection クラスのインスタンス

option

現在、以下のオプションがサポートされています:

サポートされる実行時 FTP オプション
FTP_TIMEOUT_SEC ネットワーク関連処理で使用されるカレントのタイムアウトを返します。
FTP_AUTOSEEK オプションが設定されている場合に true を、それ以外の場合に false を返します。

戻り値

成功した場合はその値を、指定した option がサポートされていない場合は false を返します。後者の場合は、 同時に警告メッセージも発生します。

変更履歴

バージョン 説明
8.1.0 引数 ftp は、FTP\Connection のインスタンスを期待するようになりました。 これより前のバージョンでは、リソース を期待していました。

例1 ftp_get_option() の例

<?php
// 指定した FTP ストリームのタイムアウトを取得する
$timeout ftp_get_option($ftpFTP_TIMEOUT_SEC);
?>

参考

  • ftp_set_option() - さまざまな FTP 実行時オプションを設定する

add a note add a note

User Contributed Notes 1 note

up
1
elamrani dot sv dot laza at gmail dot com
1 year ago
Please note that you can use this function to get the value of FTP_USEPASSIVEADDRESS option also :

<?php

$conn
= ftp_connect("host");
$login = ftp_login($conn, "user", "password");

var_dump(ftp_get_option($conn, FTP_USEPASVADDRESS)); // true (which is the default value)

ftp_set_option($conn, FTP_USEPASVADDRESS, false); // change the value

var_dump(ftp_get_option($conn, FTP_USEPASVADDRESS)); // false

?>
To Top