array_shift()

PHPのarray_shift()関数は、配列から、先頭の配列要素を取り除く組み込み関数。

定義

多様な型 array_shift( 配列型 &$array );

パラメータ

配列型 &$array

先頭の要素を取り除く対象の配列。

戻り値

「配列型 &$array」から取り除いた先頭の配列要素の値。

構文

配列から先頭の要素を取り除く

先頭の要素 = array_shift( 配列 );

「配列」から、先頭の配列要素を取り除く。

サンプル

配列から先頭の要素を取り除く

<pre>
<?php
$varArray = array( "Red", "Blue", "Green" );
$var = array_shift( $varArray );
echo "取り除いた配列要素は、「" . $var. "」<br />";
echo "取り除いた後の配列は、<br />";
print_r( $varArray );
?>
</pre>

↓↓↓出力結果↓↓↓

取り除いた配列要素は、「Red」
取り除いた後の配列は、
Array
(
    [0] => Blue
    [1] => Green
)

連想配列から先頭の要素を取り除く

<pre>
<?php
$varArray = array(
    "red" => "赤",
    "blue" => "青",
    "green" => "緑"
);
$var = array_shift( $varArray );
echo "取り除いた配列要素は、「" . $var. "」<br />";
echo "取り除いた後の配列は、<br />";
print_r( $varArray );
?>
</pre>

↓↓↓出力結果↓↓↓

取り除いた配列要素は、「赤」
取り除いた後の配列は、
Array
(
    [blue] => 青
    [green] => 緑
)

多次元配列から先頭の要素を取り除く

<pre>
<?php
$varArray = array(
    "english" => array( "red", "blue", "yellow" ),
    "kanji" => array(
        "aka" => "赤",
        "ao" => "青",
        "ki" => "黄"
    ),
    "katakana" => array( "レッド", "ブルー", "イエロー" )
);
$var = array_shift( $varArray );
echo "取り除いたのは、<br />";
print_r( $var );
echo "取り除いた後の配列は、<br />";
print_r( $varArray );
?>
</pre>

↓↓↓出力結果↓↓↓

取り除いたのは、
Array
(
    [0] => red
    [1] => blue
    [2] => yellow
)
取り除いた後の配列は、
Array
(
    [kanji] => Array
        (
            [aka] => 赤
            [ao] => 青
            [ki] => 黄
        )

    [katakana] => Array
        (
            [0] => レッド
            [1] => ブルー
            [2] => イエロー
        )

)

スポンサード リンク

カテゴリー: PHP, 組み込み関数, 編集, 配列 タグ: パーマリンク