PHPにおける関数：同じような処理をまとめて扱うしくみ

連載 :

2015年3月11日(水)

はじめに

これから始めるPHP入門コラムでは、PHPを学ぶ人が、PHPで簡単なプログラムを書けるようになるまでに必要な知識とポイントをTips的に書いていきます。今後PHPのスキルを身につけて仕事に役立てたい、という方のために「PHP技術者認定初級試験」の出題範囲を意識しながら進めていきますので、ぜひ最後までお付き合いください。

今回のあらすじ

関数の使い道（1）
関数から結果（返り値）を受け取る方法
引数のデフォルト値を設定する
関数の使い道（2）
関数内での変数のスコープ

関数の使い道（1）

プログラムを書いていて、同じような処理が2回以上現れることってありますよね。下のコードの「消費税込みの金額と改行を出力する」という部分に着目しましょう。

// リンゴ：値段を決める
$apple_price = 100;
// リンゴ：消費税込みの金額と改行を出力する。
echo floor($apple_price * 1.08) . "\n";

// みかん：値段を決める
$orange_price = 70;
// みかん：消費税込みの金額と改行を出力する。
echo floor($orange_price * 1.08) . "\n";

こういうときは、同じような処理を「関数」として一ヶ所にまとめておくと便利です。PHPにはsubstrのように最初から用意されている関数もありますが、自分で関数を作ることもできます（ユーザー定義関数）。まずは関数の作り方（宣言方法）を見てみましょう。

// 消費税込みの金額と改行を出力する関数の宣言
function echo_price_inc_tax($price) {
    echo floor($price * 1.08) . "\n";
}

この関数では、第一引数（$price）で消費税抜きの金額を受け取ります。変数$priceは、この関数の内部で使うためのもので、別の名前でも構いません。

「echo_price_inc_tax」という関数名は、すでにある関数と被らない限り、自由に付けることができます。関数名は大文字と小文字を区別しないので、上記の関数は「echo_PRICE_inc_TAX」という名前でも参照できます。

なお、関数名は自由に付けられると書きましたが、「echo_zeikomi」のように日本語で付けるのは避けた方がよいでしょう。せっかくプログラミングは世界共通言語なのですから、いつ海外のプログラマーが開発に参加しても困らないように、そして私たちも英語で書く癖を付けられるように、変数名や関数名は英語で付けましょう。
また、プログラマー自身や開発チームによって、命名ルールが設けられていることもあります。

ユーザー定義関数の使い方は、これまでに使ったことのあるsubstrなどのPHP関数と同様です。このように書けば、

echo_price_inc_tax(200);

以下のように実行されます。

echo floor(200 * 1.08) . "\n";

関数を使うことで、冒頭のコードは次のように書き換えられます。なおPHPの場合、プログラム内での関数の宣言をする位置は、関数を使う場所より前でも後でも構いません。

// リンゴ：値段を決める
$apple_price = 100;
// リンゴ：消費税込みの金額と改行を出力する。
echo_price_inc_tax($apple_price);

// みかん：値段を決める
$orange_price = 70;
// みかん：消費税込みの金額と改行を出力する。
echo_price_inc_tax($orange_price);

// 消費税込みの金額と改行を出力する関数の宣言
function echo_price_inc_tax($price) {
    echo floor($price * 1.08) . "\n";
}

この例の場合、関数にまとめることで、良いことが2つあります。

（1）同じ処理を書いたはずが間違ってしまうという可能性を防ぐことができる

下のコードを見てください。リンゴと同じように書いたはずが、一文字だけ間違っています。たった一文字でもこれは大きな間違いですが、大量のコードの中で、このような間違いを見つけることはとても難しいことです。

// レモン：消費税込みの金額と改行を出力する。
echo floor($lemon_price + 1.08) . "\n";

関数にしておけば、書き間違いにより処理が異なってしまう可能性は低くなります。また、自分以外の人が同じ処理を書く場合にも、統一が取れるようになります。

// レモン：消費税込みの金額と改行を出力する。
echo_price_inc_tax($lemon_price);

（2）修正するときに一ヶ所を修正するだけで済む

消費税はいつまでも8％であるとは限りません（2015年3月現在）。いずれ10％になってしまったら、1.08になっている部分をすべて1.1に修正しないといけません。他の可能性としては、将来のバージョンアップで税込み価格の後ろの改行（"\n"）を削除するかもしれません。その場合でも、関数にしておけば一ヶ所を修正するだけで済みます。

関数を使わない場合の修正部分
// リンゴ：消費税込みの金額と改行を出力する。
echo floor($apple_price * 1.1);
// みかん：消費税込みの金額と改行を出力する。
echo floor($orange_price * 1.1);

関数を使う場合の修正部分
// 消費税込みの金額と改行を出力する関数
function echo_price_inc_tax($price) {
    echo floor($price * 1.1);
}

関数から結果（返り値）を受け取る方法

さて、「税込み金額は知りたいけれど、出力はしたくない」という場合があるかもしれません。そのような場合は、returnを使って関数から結果（返り値）を返すことができます。

// 消費税込みの金額と改行を返す関数の宣言
function get_price_inc_tax($price) {
    return floor($price * 1.08) . "\n";
}

このように書けば、

$price_inc_tax = get_price_inc_tax(200);

以下のように実行されます。

$price_inc_tax = floor(200 * 1.08) . "\n";

また、returnを複数使って、条件によって返り値の求め方を変えることができます。

// 消費税込みの金額と改行を返す関数の宣言
function get_price_inc_tax($price, $year) {
    // 消費税8％時代の場合
    if ($year >= 2014) {
        return floor($price * 1.08) . "\n";
    }
    // 消費税5％時代の場合
    if ($year >= 1997) {
        return floor($price * 1.05) . "\n";
    }
    // 消費税3％時代の場合
    if ($year >= 1989) {
        return floor($price * 1.03) . "\n";
    }
    // 消費税導入前の場合
    return $price . "\n";
}

ただしこの例の場合は、以下のように書くほうが一般的です。同じ処理（「 . "\n"」の部分など）は、なるべく繰り返さないようにしましょう。

// 消費税込みの金額と改行を返す関数の宣言
function get_price_inc_tax($price, $year) {
    // 消費税8％時代
    if ($year >= 2014) {
        $tax = 8;
    }
    // 消費税5％時代
    else if ($year >= 1997) {
        $tax = 5;
    }
    // 消費税3％時代
    else if ($year >= 1989) {
        $tax = 3;
    }
    // 消費税導入前
    else {
        $tax = 0;
    }
    return floor($price * (1 + $tax/100)) . "\n";
}

引数のデフォルト値を設定する

先ほどの関数「get_price_inc_tax」を使う場合には、2つの引数を両方とも指定しないとエラーになります。

// 消費税込みの金額と改行を返す関数の宣言
function get_price_inc_tax($price, $year) {
    ...
}
$apple_price_inc_tax = get_price_inc_tax(100);
// PHPエラー
// Warning: Missing argument 2 for get_price_inc_tax(), called in ...

しかし、いちいち$yearの値を指定するのは面倒かもしれません。

$apple_price_inc_tax = get_price_inc_tax(100, 2015);
$orange_price_inc_tax = get_price_inc_tax(70, 2015);

この場合、次のように書けば$yearを指定しなくとも大丈夫になります。$yearを指定せずに関数を呼び出すと、代わりに2015が使われます。

// 消費税込みの金額と改行を返す関数の宣言
function get_price_inc_tax($price, $year = 2015) {
    ...
}
// $price = 100、$year = 2015が使われる
$apple_price_inc_tax = get_price_inc_tax(100);
// $price = 110、$year = 2010が使われる
$old_apple_price_inc_tax = get_price_inc_tax(110, 2010);

関数の中から別の関数を呼ぶ

関数の中から、さらに別の関数を呼ぶこともできますので、先ほどの「get_price_inc_tax」は以下のように書き換えることができます。

// 消費税込みの金額と改行を出力する関数の宣言
function echo_price_inc_tax($price) {
    // 修正前：echo floor($price * 1.08) . "\n";
    echo get_price_inc_tax($price);
}
// 消費税込みの金額と改行を返す関数の宣言
function get_price_inc_tax($price) {
    return floor($price * 1.08) . "\n";
}