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

STR_PAD_RIGHT定数の使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2026年03月12日

基本的な使い方

STR_PAD_RIGHT定数は、PHP言語において文字列を指定した長さにパディング（埋め込み）する際の挙動を制御するために使用される定数です。この定数は主に、str_pad()関数という、ある文字列を特定の長さにするために、指定した文字で埋める機能を持つ関数と組み合わせて利用されます。

具体的には、str_pad()関数の第三引数であるパディングの種類を指定する際にSTR_PAD_RIGHTを指定することで、元の文字列の右側に埋め文字が追加されるようになります。例えば、「Hello」という文字列を10文字の長さにする際に、残りの5文字を空白文字で埋めたい場合、この定数を使うことで「Hello 」のように文字列の右側が空白で埋められます。これにより、データの表示形式を統一したり、特定のフォーマットに合わせて文字列を整形したりする際に非常に役立ちます。

プログラミングでは、数値の桁揃えや表形式のデータ表示、あるいはログ出力の際の体裁を整えるなど、文字列の長さを揃える必要がある場面が数多く存在します。STR_PAD_RIGHT定数は、そのような要件に対して、直感的に「文字列の右側を埋める」という明確な意図をコード上で表現することを可能にし、プログラムの可読性を高めます。他にも文字列の左側を埋めるSTR_PAD_LEFTや、左右均等に埋めるSTR_PAD_BOTHといった関連する定数も存在し、用途に応じて適切な埋め方を選択することができます。これらの定数を用いることで、開発者は文字列の整形処理をより柔軟かつ効率的に実装することが可能です。

構文(syntax)


1<?php
2str_pad("input", 10, " ", STR_PAD_RIGHT);

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP STR_PAD_RIGHT で文字列を右に詰める


1<?php
2
3/**
4 * STR_PAD_RIGHT 定数を使用して文字列を右側にパディングする例。
5 *
6 * str_pad() 関数は、文字列を指定された長さまで別の文字列で埋めます。
7 * STR_PAD_RIGHT は、パディング文字を文字列の右側に追加するよう指定します。
8 */
9function demonstrateStrPadRight(): void
10{
11    $originalString = "PHP";
12    $targetLength = 10;
13    $padCharacter = "-";
14
15    echo "元の文字列: '" . $originalString . "'\n";
16    echo "目標の長さ: " . $targetLength . "\n";
17    echo "パディング文字: '" . $padCharacter . "'\n\n";
18
19    // STR_PAD_RIGHT を使用して、文字列の右側にパディングします。
20    // PHP は '---PHP' ではなく 'PHP-------' になります。
21    $paddedString = str_pad($originalString, $targetLength, $padCharacter, STR_PAD_RIGHT);
22
23    echo "STR_PAD_RIGHT でパディングされた文字列: '" . $paddedString . "'\n";
24    echo "パディング後の文字列の長さ: " . mb_strlen($paddedString) . "\n";
25
26    echo "\n別の例:\n";
27    $name = "Taro";
28    $paddedName = str_pad($name, 15, " ", STR_PAD_RIGHT); // 一般的な右詰め
29    echo "名前の右詰め: '" . $paddedName . "' (長さ: " . mb_strlen($paddedName) . ")\n";
30}
31
32// 関数の実行
33demonstrateStrPadRight();
34

PHPのSTR_PAD_RIGHTは、文字列を特定の長さになるように埋める（パディングする）方向を指定するための定数です。この定数自体には引数も戻り値もありませんが、主にstr_pad()関数と組み合わせて使用されます。str_pad()関数は、第一引数に指定した文字列を、第二引数で指定された目標の長さになるまで、第三引数で指定された文字で埋める機能を提供します。

ここでSTR_PAD_RIGHTをstr_pad()関数の第四引数に指定すると、元の文字列の右側にパディング文字が追加され、指定された目標の長さに文字列が調整されます。例えば、「PHP」という文字列を長さ10に「-」でSTR_PAD_RIGHTを使ってパディングすると、結果は「PHP-------」となり、元の文字列が左に寄せられ、残りのスペースが指定された文字で埋められます。

サンプルコードでは、"PHP"という文字列を目標の長さ10にハイフンで右側をパディングし、"PHP-------"という結果が得られています。また、"Taro"を長さ15に空白で右側をパディングする例では、"Taro "という右寄せされた文字列が生成されています。これは、レポート出力や画面表示などで文字列の桁数を揃えたい場合に非常に役立ちます。str_pad()関数は、このようにパディング処理が施された新しい文字列を戻り値として返します。

STR_PAD_RIGHTは、str_pad()関数の第4引数として、パディング方向を「右側」に指定するための定数です。単体で動作するものではありませんのでご注意ください。

str_pad()関数は、元の文字列が目標の長さより短い場合にのみ、この定数に従ってパディング文字を右側に追加します。元の文字列が目標の長さと同じかそれ以上の場合、文字列が切り詰められることなくそのまま返されますので、意図しない短縮の心配はありません。

PHP 8のstr_pad()関数はマルチバイト文字の長さを正しく扱えますが、多様な文字コード環境下でより堅牢に利用したい場合は、mb_internal_encoding()の設定や、より厳密な制御が必要な場合はmb_str_pad()関数の利用も検討すると良いでしょう。