クエリに使う文字列をエスケープする

# pg_escape_string

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

pg_escape_string — クエリに使う文字列をエスケープする

### 説明

function pg_escape_string(PgSql\Connection `$connection` = ?, string `$string`): string

pg_escape_string() は、データベースへの問い合わせに使う文字列をエスケープします。 PostgreSQL フォーマットにエスケープされた文字列を、クォートなしの形式で返します。 PostgreSQL に使う SQL パラメータをエスケープするときには pg_escape_literal() を使うほうがよいでしょう。 addslashes() を PostgreSQL で使ってはいけません。 カラム型が bytea の場合は、代わりに pg_escape_bytea() を使わなければなりません。 識別子 (テーブル名やフィールド名など) のエスケープには pg_escape_identifier() を使わなければなりません。

### パラメータ

`connection`

  PgSql\Connection クラスのインスタンス。 `connection` が指定されない場合は、デフォルトの接続を使います。 デフォルトの接続とは、pg_connect() または pg_pconnect() によって確立された直近の接続です。

  警告

  PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。

`string`

  エスケープするテキスト文字列。

### 戻り値

エスケープされたデータを文字列で返します。

### 変更履歴

バージョン | 説明
--- | ---
8.1.0 | `connection` は、PgSql\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、resource を期待していました。

### 例

例1 pg_escape_string() の例

    <?php
      // データベースに接続する
      $dbconn = pg_connect('dbname=foo');

      // テキストファイルを読み込む（アポストロフィやスラッシュが含まれている）
      $data = file_get_contents('letter.txt');

      // テキストデータをエスケープする
      $escaped = pg_escape_string($data);

      // それをデータベースに挿入する
      pg_query("INSERT INTO correspondence (name, data) VALUES ('My letter', '{$escaped}')");
    ?>

### 参考

- pg_escape_bytea() - bytea フィールドに挿入するために文字列をエスケープする

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open