PHPのftp_set_option()関数とは？使い方とパラメータを解説

PHPのftp_set_option()関数は、FTP接続に対して実行時オプションを設定するための関数です。タイムアウト時間や自動シークの動作など、FTP接続の挙動を細かく制御したい場合に活用できます。

基本構文

ftp_set_option(conn, option, value);

パラメータ

• conn − 対象となるFTP接続（リソース）を指定します。

• option − 設定する実行時オプションを指定します。指定できる主な値は以下の通りです。

  - FTP_TIMEOUT_SEC: ネットワーク操作のタイムアウト秒数を設定します。

  - FTP_AUTOSEEK: 自動シーク機能の有効（TRUE）／無効（FALSE）を切り替えます。

• value − 上記のoptionパラメータに対応する値を指定します。例えばFTP_TIMEOUT_SECの場合は秒数を整数で、FTP_AUTOSEEKの場合はTRUEまたはFALSEを渡します。

戻り値

オプションが正常に設定できた場合はTRUEを返し、設定に失敗した場合はFALSEを返します。

使用例

以下は、FTP接続のタイムアウトを60秒に設定するサンプルコードです。

<?php
    $ftp_server = "192.168.0.4";
    $ftp_user = "username";
    $ftp_pass = "gfhgfj236k";
    $conn = ftp_connect($ftp_server) or die("$ftp_server に接続できませんでした");
    $login = ftp_login($conn, $ftp_user, $ftp_pass);
    echo ftp_set_option($conn, FTP_TIMEOUT_SEC, 60);
    // 接続を閉じる
    ftp_close($conn);
?>

補足ポイント

なお、上記のサンプルでは変数名の誤り（$con と $conn の混在）があるとログインが失敗するため、実際に使用する際は接続リソースの変数名を統一してください。また、ftp_set_option()はftp_connect()で接続を確立した後に呼び出す必要があります。