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

# pg_escape_string

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

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

### 説明

pg_escape_string ([ resource `$connection` ], string `$data` ) : string

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

> 注意:

> この関数は、PostgreSQL 7.2 以降が必要です。

### パラメータ

`connection`

  PostgreSQL データベース接続リソース。 `connection` が存在しない場合は、 デフォルトの接続を使用します。デフォルトの接続は、 pg_connect() あるいは pg_pconnect() で直近に作成されたものとなります。

`data`

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

### 返り値

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

### 変更履歴

バージョン | 説明
--- | ---
5.2.0 | `connection` が追加されました。

### 例

例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 フィールドに挿入するために文字列をエスケープする