PHPのarray_pop関数の使い方！配列の末尾から要素を取り出す

PHPのarray_pop関数は、配列の末尾から1つの要素を取り除き、その要素の値を返すために使用されます。

この関数は、配列をスタック（後入れ先出し：LIFO）のように扱う際によく利用されます。
例えば、処理済みの項目を配列から削除したり、キューの末尾から要素を順に取り出したりする際に便利です。

この記事では、array_pop 関数の基本的な使い方、引数、戻り値、空の配列に対する挙動、そして使用する際の注意点について解説します。

array_pop関数の基本的な構文

array_pop関数の基本的な構文は以下の通りです。

mixed array_pop(array &$array): mixed
  • $array: 要素を取り除きたい配列です。この配列は参照渡し（& 記号）されるため、関数が実行されると元の配列が直接変更されます。

array_pop関数の戻り値

取り除かれた要素の値が返されます。
配列が空の場合、何も取り除かれずnullが返されます。

array_pop関数を使ってみる

実際にarray_pop関数を使って、動作を確認していきます。

例1：数値配列の末尾から要素を取り出す

数値配列の末尾をarray_pop関数で取得してみます。

<?php
$numbers = [10, 20, 30, 40, 50];

$lastElement = array_pop($numbers);

echo "取り出された要素: " . $lastElement . PHP_EOL; // 出力: 取り出された要素: 50
print_r($numbers);
// インデックスはそのままで、末尾の要素だけが削除されていることがわかります。
// 出力:
// Array
// (
//     [0] => 10
//     [1] => 20
//     [2] => 30
//     [3] => 40
// )
?>

$numbers配列を作成して、配列にたいしてarray_pop関数を使っています。
結果を確認すると、配列から「50」が削除され、配列の要素数が減っていることがわかります。

例2：文字列配列の末尾から要素を取り出す

文字列配列の末尾から要素を取り出してみます。

<?php
$fruits = ['apple', 'banana', 'orange', 'grape'];

$removedFruit = array_pop($fruits);

echo "取り出された果物: " . $removedFruit . PHP_EOL; // 出力: 取り出された果物: grape
print_r($fruits);
// 出力:
// Array
// (
//     [0] => apple
//     [1] => banana
//     [2] => orange
// )
?>

$fruits文字列配列から、array_pop関数を使って、末尾の文字列を取得しています。
結果を確認すると、末尾の文字列が取り出されて、配列から末尾の「grape」が削除されました。

例3：連想配列の末尾から要素を取り出す

連想配列の場合でも、最後に追加された要素が削除されます。

<?php
$user = [
    'id' => 101,
    'name' => 'Alice',
    'email' => 'alice@example.com'
];

$removedValue = array_pop($user);

echo "取り出された値: " . $removedValue . PHP_EOL; // 出力: 取り出された値: alice@example.com
print_r($user);
// 出力:
// Array
// (
//     [id] => 101
//     [name] => Alice
// )
?>

連想配列の場合、PHPの内部的な順序で最後に位置する要素が取り除かれます。
通常は最後に追加された要素です。

空の配列に対する挙動

array_pop を空の配列に適用した場合、null が返され、警告（Warning）は発生しません。

<?php
$emptyArray = [];

$result = array_pop($emptyArray);

var_dump($result); // 出力: NULL
print_r($emptyArray); // 出力: Array() (空のまま)
?>

空配列にたいして、array_pop関数を使っています。
結果、空になることが確認できます。

array_pop関数を使う際の注意点

  • 元の配列が変更される: 最も重要な注意点です。array_pop は元の配列を破壊的に変更します。関数を呼び出した後、元の配列は要素が1つ減った状態になります。もし元の配列を保持したい場合は、事前に array_slice() などでコピーを作成するか、別の方法を検討してください。
  • スタック操作として利用: array_pop は、array_push()（配列の末尾に要素を追加）と組み合わせることで、LIFO（後入れ先出し）のスタックデータ構造を実装するのに非常に適しています。
  • 単一要素の削除: 常に1つの要素しか削除しません。複数の要素を削除したい場合は、ループを使用するか、array_splice() のような他の関数を検討してください。

array_popとarray_shiftの違い

array_pop と似た関数に array_shift があります。
これらの違いは、要素を取り除く方向です。

関数 動作 要素の取り除く方向 キーの扱い
array_pop 配列の末尾から1つの要素を取り除く 末尾（右側） 連想配列のキーは削除される
array_shift 配列の先頭から1つの要素を取り除く 先頭（左側） 全てのキーが再インデックスされる（数値インデックスは0から振り直し）

※ 連想配列の場合、array_shiftを使ってもキーは再インデックスされません。

まとめ

PHPの array_pop 関数は、配列の末尾から要素を効率的に取り除くための関数です。
スタックのようなデータ構造を扱う際に非常に便利ですが、元の配列が変更されるという性質を理解して使用することが重要です。

array_pushと組み合わせることでスタック操作を実現でき、array_shiftとの動作の違いを把握することで、配列操作の選択肢が広がります。

PHP
yasuaki

コメント