array_unshift()

PHPのarray_unshift()関数は、配列の先頭に、ひとつ以上の配列要素を追加する組み込み関数。

定義

整数型 array_unshift( 配列型 &$array, 多様な型 $var[, 多様な型 $...] );

パラメータ

配列型 &$array

先頭に要素を追加する対象の配列。

多様な型 $var

配列の先頭に追加する要素の値。

カンマ,で区切り、複数指定できる。

戻り値

「配列型 &$array」に配列要素を追加した後の、「配列型 &$array」の配列要素数。

構文

配列の先頭に、配列要素を追加

追加後の配列要素数 = array_unshift( 配列, 追加要素の値 );

「配列」の先頭に、「追加要素の値」を追加する。

配列の先頭に、複数の配列要素を追加

追加後の配列要素数 = array_unshift( 配列, 追加要素の値1, 追加要素の値2, 追加要素の値3 );

「配列」の先頭に、「追加要素の値1」「追加要素の値2」「追加要素の値3」を追加する。

サンプル

配列の先頭に、配列要素を追加

<pre>
<?php
$varArray = array( "白", "黒" );
$var = array_unshift( $varArray, "赤" );
echo "追加後の配列要素数は、「" . $var. "」<br />";
echo "追加後の配列は、<br />";
print_r( $varArray );
?>
</pre>

↓↓↓出力結果↓↓↓

追加後の配列要素数は、「3」
追加後の配列は、
Array
(
    [0] => 赤
    [1] => 白
    [2] => 黒
)

配列の先頭に、複数の配列要素を追加

<pre>
<?php
$varArray = array( "白", "黒" );
$var = array_unshift( $varArray, "赤", "青", "緑" );
echo "追加後の配列要素数は、「" . $var. "」<br />";
echo "追加後の配列は、<br />";
print_r( $varArray );
?>
</pre>

↓↓↓出力結果↓↓↓

追加後の配列要素数は、「5」
追加後の配列は、
Array
(
    [0] => 赤
    [1] => 青
    [2] => 緑
    [3] => 白
    [4] => 黒
)

スポンサード リンク

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