array_pad()

PHPのarray_pad()関数は、指定長まで、指定した値で配列を埋め、指定長配列を作る組み込み関数。

定義

配列型 array_pad( 配列型 $input, 整数型 $pad_size, 多様な型 $pad_value );

パラメータ

配列型 $input

対象の配列を指定。

整数型 $pad_size

新しい配列の要素数。

正数を指定すると、配列の右側を埋める。

負数を指定すると、配列の左側を埋める。

多様な型 $pad_value

「配列型 $input」の配列の要素数が、「整数型 $pad_size」よりも少ないときに、埋めるために使用する値。

戻り値

指定長まで、指定した値で埋めた指定長配列。

構文

指定長配列作成

指定長の配列 = array_pad( 配列, 整数,);

「配列」の要素の数が、「整数」の数になるまで、「値」で埋め、「指定長の配列」を作成する。

サンプル

配列の右側を埋めた指定長配列

<pre>
<?php
$varArray = array( "レッド", "ブルー" , "イエロー" );
print_r( array_pad( $varArray, 5, "無色" ) );
?>
</pre>

↓↓↓出力結果↓↓↓

Array
(
    [0] => レッド
    [1] => ブルー
    [2] => イエロー
    [3] => 無色
    [4] => 無色
)

配列の左側を埋めた指定長配列

<pre>
<?php
$varArray = array( "レッド", "ブルー" , "イエロー" );
print_r( array_pad( $varArray, -5, "無色" ) );
?>
</pre>

↓↓↓出力結果↓↓↓

Array
(
    [0] => 無色
    [1] => 無色
    [2] => レッド
    [3] => ブルー
    [4] => イエロー
)

連想配列の右側を埋めた指定長配列

<pre>
<?php
$varArray = array(
    "red" => "レッド",
    "blue" => "ブルー",
    "yellow" => "イエロー"
);
print_r( array_pad( $varArray, 5, "無色" ) );
?>
</pre>

↓↓↓出力結果↓↓↓

Array
(
    [red] => レッド
    [blue] => ブルー
    [yellow] => イエロー
    [0] => 無色
    [1] => 無色
)

連想配列の左側を埋めた指定長配列

<pre>
<?php
$varArray = array(
    "red" => "レッド",
    "blue" => "ブルー",
    "yellow" => "イエロー"
);
print_r( array_pad( $varArray, -5, "無色" ) );
?>
</pre>

↓↓↓出力結果↓↓↓

Array
(
    [0] => 無色
    [1] => 無色
    [red] => レッド
    [blue] => ブルー
    [yellow] => イエロー
)

スポンサード リンク

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