【PHP8.x】STR_PAD_BOTH定数の使い方

STR_PAD_BOTH定数は、文字列を特定の長さに整形する際に使用されるパディング（埋め合わせ）の方向を表す定数です。これはPHP 8で利用可能な定数の一つで、主にstr_pad()関数と組み合わせて使用されます。

str_pad()関数は、与えられた文字列を指定された目標の長さに調整するために、必要に応じて文字列の左右、または両側に特定の文字を挿入する機能を提供します。この際に、どの方向に文字を挿入するかを決定するのがパディング方向の定数です。STR_PAD_BOTH定数をstr_pad()関数の第3引数として指定すると、元の文字列の左右両側にパディング文字が均等に挿入されます。

具体的には、目標の長さと元の文字列の長さの差分がパディングの必要な文字数となり、この文字数が左右に割り振られます。もしパディング文字数が奇数である場合、右側により多くのパディング文字が追加される挙動となります。例えば、目標の長さが元の文字列より3文字長い場合、左に1文字、右に2文字のパディングが行われます。

この定数を使用することで、出力される文字列を中央寄せのように見せたり、整形された表形式のデータを生成したりするなど、多様な文字列処理において視覚的な整列を実現することができます。STR_PAD_BOTH定数は、プログラム内で文字列の表示形式を細かく制御するための重要な要素の一つです。

Copy
1<?php
2$text = "Hello";
3$padded_text = str_pad($text, 10, "=", STR_PAD_BOTH);
4echo $padded_text;

引数なし

引数はありません

戻り値なし

戻り値はありません