PHPでbindparamを使う方法を現役エンジニアが解説【初心者向け】

初心者向けにPHPでbindparamを使う方法について解説しています。PHPのbindParam()関数は、プリペアドステートメントで使用するSQL文の中で、プレースホルダーに値をバインドするための関数です。あらかじめ用意されたひな形に値を埋め込みます。bindValueとの違いについても確認しましょう。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

今回は、PHPでbindparamを使う方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

 

PHPについてそもそもよく分からないという方は、PHPとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、PHP/Laravel講座の内容をもとに紹介しています。

 

田島悠介

今回は、PHPに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

PHPでbindparamを使う方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

bindparamとは

PHPのbindParam()関数は、プリペアドステートメントで使用するSQL文の中で、プレースホルダーに値をバインドするための関数です。

bindParam()関数は、値の参照を受け取るという点と、execute()関数を使用した際にバインドが確定するという点で、bindValue()関数と異なります。

プリペアドステートメントとは、SQL文をあらかじめ用意しておいて、その後はクエリ内のパラメータの値だけを変更してクエリを実行できる機能のことです。
 

プリペアドステートメント

PHPではprepare()関数を使用することで、プリペアドステートメントを使用できます。

<?php
$userName = 'mysql';
$password = 'mysql';
// PDOオブジェクトの生成(DB接続)
$pdo = new PDO('mysql:dbname=test;host=localhost', $userName, $password);

// プリペアドステートメントで SQLをあらかじめ用意しておく
$stmt = $pdo->prepare('select * from user where id = ? and name = ?');

prepare()関数を使用するためには、まずPDOオブジェクトを生成する必要があります。

PDOオブジェクトを生成時にDB接続情報を渡すことで、対象のDBに対してSQLを実行できるようになります。

prepare()関数の()内が、プリペアドステートメントによるSQLです。$pdo->prepare()とすることで、接続したDBに対して実行するプリペアドステートメントのSQLをセットします。

プリペアドステートメントの「?」の部分は、プレースホルダーと呼ばれるものです。

bindParam()関数を使用することで、このようなプレースホルダーに値をバインドさせることができるので、条件が動的なSQLをアプリケーションから実行できます。
 

[PR] PHPのプログラミングで挫折しない学習方法を動画で公開中

bindvalueとの違い

同じくプレースホルダーにバインドする関数として、bindValue()という関数がPHPには用意されています。

bindValue()関数との大きな違いは、バインドするために「変数」を引数として渡すことで、変数が「参照として」バインドされる点です。

そのため、バインドした値が評価されるタイミングがbindParam()関数とbindValue()関数で異なります。
 

bindvalueの場合

bindValue()関数の場合は、関数に値を渡したタイミングでバインドが評価されます。

$stmt->bindValue(1, $id, PDO::PARAM_INT);
$stmt->bindValue(2, $name);

 

bindParamの場合

bindParam()関数の場合は、クエリを実行する関数execute()が実行されるまで、バインドが評価されません。

そのため、一度bindParam()関数に変数を渡しても、execute()が実行される前に変数の値が変更されると、その変更した値がexecute()の実行時のクエリに反映されます。

// 値をバインド
$id = 1;
$name = '田中太郎';
$stmt->bindParam(1, $id, PDO::PARAM_INT);
$stmt->bindParam(2, $name);

// クエリを実行($id, $nameの中身をバインド)
$stmt->execute();

// 値の変更
$id = 2;
$name = '鈴木一郎';

// クエリを実行($id, $nameの中身をバインド)
$stmt->execute();

 

bindparamを使う方法

それでは、bindParam()関数の使用方法について、見ていきましょう。

bindParam ($パラメータID, $バインドする変数 [, $PDOデータ型定数[, $PDOデータ型の長さ[, $ドライバーオプション]]] )

第一引数には、パラメータIDを使用します。これは、プレースホルダーの種類によって指定方法が異なります。

もし、プレースホルダーが「?」を使用する、「疑問符プレースホルダー」の場合、パラメータIDには1から始まる整数値で「?」の位置を指定します。

もし、プレースホルダーが「:id」など、名前で指定する「名前つきプレースホルダー」の場合、パラメータIDにはプレースホルダーと同じ:idなどの文字列で指定します。

第二引数には、バインドする変数を渡します。

第三引数は、オプションで、バインドする値に対して明示的にデータ型を指定することができます。指定する場合は、「PDO::PARAM_* 定数 」を使用します。デフォルトでは、「PDO::PARAM_STR」がセットされています。

第四引数には、オプションで、バインドする値のデータ型の長さを指定することができます。値がストアドプロシージャからの OUT パラメータであることを示す場合、 明示的に長さを設定しなければなりません。

第五引数には、オプションで、ドライバー固有のオプションを渡すことができます。 例としては、「UTF-8 でエンコードされた文字列として列を変数にバインドする」などのドライバーオプションが存在します。

返却値は、バインドに成功した場合、bool値のTRUEが、失敗した場合には、bool値のFALSEが返却されます。
 

実際に書いてみよう

それでは、bindParam()関数を使用して、プリペアドステートメントでセットしたSQL文に値をバインドする例を見ていきましょう。

プレースホルダーの種類によって値のバインド方法が異なるので、「疑問符プレースホルダー」と「名前つきプレースホルダー」の場合の2つの実例を紹介します。
 

疑問符プレースホルダー

ここでは、疑問符プレースホルダーの場合の値のバインドについて見ていきます。

<?php
$userName = 'mysql';
$password = 'mysql';
// PDOオブジェクトの生成(DB接続)
$pdo = new PDO('mysql:dbname=test;host=localhost', $userName, $password);

// プリペアドステートメントで SQLをあらかじめ用意しておく
$stmt = $pdo->prepare('select * from user where id = ? and name = ?');

// 値をバインド
$id = 1;
$name = '田中太郎';
$stmt->bindParam(1, $id, PDO::PARAM_INT);  // ①
$stmt->bindParam(2, $name); // ②

// executeでクエリを実行
$stmt->execute();

上記の例で、①のbindParam()関数では、第一引数のパラメータIDに、数値の1を指定しています。

②のbindParam()関数では、第一引数のパラメータIDに、数値の2を指定しています。この数値は、prepare()関数で生成したプリペアドステートメントのSQL内の「?」の位置を指定しています。数値が1の場合は、SQL文に最初の?の位置を指定し、数値が2の場合は、SQL文に2つ目の?の位置を指定してバインドします。
 

名前つきプレースホルダー

ここでは、名前つきプレースホルダーの場合の値のバインドについて見ていきます。

<?php
$userName = 'mysql';
$password = 'mysql';
// PDOオブジェクトの生成(DB接続)
$pdo = new PDO('mysql:dbname=test;host=localhost', $userName, $password);
// プリペアドステートメントで SQLをあらかじめ用意しておく
$stmt = $pdo->prepare('select * from user where id = :id and name = :name');
// 値をバインド
$id = 1;
$name = '田中太郎';
$stmt->bindParam(':id', $id, PDO::PARAM_INT);
$stmt->bindParam(':name', $name);

// executeでクエリを実行
$stmt->execute();

上記の例のように、bindParam()関数の第一引数をプリペアドステートメントのSQL文にある:idのような名前つきプレースホルダーの文字列を指定することで、対象の名前プレースホルダーにバインドされます。
 

筆者プロフィール

平野大輝(ひらのだいき)

スキル:PHP・Java・JavaScriptを用いて様々なアプリを開発するWebエンジニア。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、PHPやフレームワークのLaravelを使ってWebアプリケーション開発を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。