PHP
 Computer >> コンピューター >  >> プログラミング >> PHP

PHPのstr_pad()関数とは?文字列のパディング方法をわかりやすく解説

PHPのstr_pad()関数は、文字列を指定した長さまで特定の文字で埋め(パディング)、新しい長さの文字列を返す関数です。文字列の左側・右側・両側に任意の文字を追加したい場合に便利です。

基本構文

str_pad(str, len, pad_str, pad_type)

パラメータの詳細

  • str − パディング対象となる元の文字列を指定します。

  • len − パディング後の新しい文字列の長さを指定します。

  • pad_str − 埋め合わせに使用する文字列(パディング文字)を指定します。省略した場合は半角スペースが使用されます。

  • pad_type − 文字列のどちら側にパディングするかを指定します。省略可能です。

  • pad_typeに指定できる定数は以下の3種類です。

    • STR_PAD_BOTH − 文字列の両側にパディングします。埋める長さが偶数でない場合、余った分は右側に追加されます。

    • STR_PAD_LEFT − 文字列の左側にパディングします。

    • STR_PAD_RIGHT − 文字列の右側にパディングします(デフォルト値)。

戻り値

str_pad()関数は、指定した長さまでパディングされた文字列を返します。元の文字列がすでに指定した長さ以上の場合は、そのまま元の文字列が返されます。

使用例1:STR_PAD_LEFT(左側にパディング)

以下の例では、文字列「Welcome」の左側を「$」で埋めて10文字にしています。

<?php
$s = "Welcome";
echo str_pad($s,10,"$",STR_PAD_LEFT);
?>

出力結果

$$$Welcome

使用例2:STR_PAD_RIGHT(右側にパディング)

次の例では、同じ文字列の右側を「$」で埋めています。

<?php
$s = "Welcome";
echo str_pad($s,10,"$",STR_PAD_RIGHT);
?>

出力結果

Welcome$$$

使用例3:STR_PAD_BOTH(両側にパディング)

最後に、両側にパディングする例です。「Welcome」は7文字なので、3文字分を埋める必要があります。奇数の場合、右側に多くのパディングが適用されます。

<?php
$s = "Welcome";
echo str_pad($s,10,"$",STR_PAD_BOTH);
?>

出力結果

$Welcome$$

まとめ

str_pad()関数を使うことで、固定桁数での表示揃えやIDのゼロ埋めなど、文字列の整形を簡単に行うことができます。第4引数のpad_typeを活用すれば、左寄せ・右寄せ・中央寄せのパディングを柔軟に制御できるので、ぜひ覚えておきましょう。

  1. PHPのquoted_printable_decode()関数とは?使い方とサンプルコードを解説

    PHPのquoted_printable_decode()関数は、quoted-printable形式でエンコードされた文字列を、8ビット文字列にデコードするために使用されます。メール本文などで使われるquoted-printableエンコーディングを元に戻したい場合に便利な関数です。 構文 quoted_printable_decode(str) パラメータ str − デコード対象となる入力文字列を指定します。 戻り値 quoted_printable_decode()関数は、デコード後の8ビットASCII文字列を返します。 使用例 以下は、quoted_printable_dec

  2. PHPのnl_langinfo()関数の使い方をわかりやすく解説

    PHPのnl_langinfo()関数は、現在のロケール(言語・地域設定)に関する情報を取得するための関数です。曜日名や月名、通貨記号、数値の書式など、ロケール固有のさまざまな情報を要素単位で取り出すことができます。通常、setlocale()でロケールを設定した後に使用します。 注意: この関数はWindows環境では動作しません。LinuxなどのUNIX系プラットフォームでのみ利用可能です。 構文 nl_langinfo(ele) パラメータ ele − 取得したい情報の要素を指定します。指定できる主な要素は以下の通りです。 時刻・カレンダー関連 ABDAY_(1-7) − 番号で指