関数・クラス解説

str_pad

文字列を指定の長さ（桁数）になるまで空白（あるいは指定文字列）で埋める

フォーマット

string : str_pad ( string $input , int $pad_length [, string $pad_string = " " [, int $pad_type = STR_PAD_RIGHT ]] )

パラメータ

string $input （必須）
元となる文字列

int $pad_length （必須）
文字列全体の長さを指定。負の値や元となる文字列の長さよりも小さい場合、処理は行われず、元となる文字列をそのまま返却します。

string $pad_string = " "
埋める箇所があると、ここで指定した文字列で埋められます。

注意: 必要とされる埋める文字数が pad_string の長さで均等に分割できない場合、pad_string は切り捨てられます。

解説

指定された元の文字列 string $input の長さが、int $pad_length に満たない場合、不足分を string $pad_string で指定した文字列で埋めて補い、指定の長さで返却します。int $pad_type を指定することで string $input の左、右、あるいは両側を指定することができます。
この関数はマルチバイト文字列には対応していません。

記述サンプル

//PHP 7.4.6で実行
//文字列を指定
$input = "abcde";

//実行
echo str_pad($input, 10);
abcde     

//指定の長さが短い場合は処理されない
echo str_pad($input, 4);
abcde

//x で埋める
echo str_pad($input, 10, "x");
abcdexxxxx

//xyz で埋める
echo str_pad($input, 10, "xyz");
abcdexyzxy

//左を埋める
echo str_pad($input, 10, "x", STR_PAD_LEFT);
xxxxxabcde

//両方を埋める
echo str_pad($input, 10, "x", STR_PAD_BOTH);
xxabcdexxx

//長さ7、指定文字が長い場合
echo str_pad($input, 7, "zyxwv");
abcdezy

//長さ7、左、指定文字が長い場合
echo str_pad($input, 7, "zyxwv", STR_PAD_LEFT);
zyabcde

//長さ7、両方、指定文字が長い場合
echo str_pad($input, 7, "zyxwv", STR_PAD_BOTH);
zabcdez

//マルチバイト文字を指定
$input = "あいう";
echo str_pad($input, 10, "_", STR_PAD_BOTH);
あいう_

//指定の長さと、文字コードによっては文字化けする
echo str_pad($input, 10, "かきくけこ");
あいう�

タグ

パディング 文字埋め String 文字列

公式リファレンス

書式

str_pad ( string $input , int $pad_length [, string $pad_string = " " [, int $pad_type = STR_PAD_RIGHT ]] ) : string

説明

この関数は文字列 input の左、右または両側を指定した長さで埋めます。オプションの引数 pad_string が指定されていない場合は、 input は空白で埋められ、それ以外の場合は、 pad_string からの文字で制限まで埋められます。

パラメータ

input

入力文字列。

pad_length

pad_length の値が負、 または入力文字列の長さ以下である場合、埋める操作は行われません。 input をそのまま返します。

pad_string

注意: 必要とされる埋める文字数が pad_string の長さで均等に分割できない場合、pad_string は切り捨てられます。

pad_type

オプションの引数 pad_type には、 STR_PAD_RIGHT, STR_PAD_LEFT, STR_PAD_BOTH を指定可能です。 pad_typeが指定されない場合、 STR_PAD_RIGHT を仮定します。

返値

埋めた後の文字列を返します。

サンプル

例1 str_pad() の例
 

$input = "Alien";
echo str_pad($input, 10);                      // 結果は "Alien     "
echo str_pad($input, 10, "-=", STR_PAD_LEFT);  // 結果は "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH);   // 結果は "__Alien___"
echo str_pad($input,  6, "___");               // 結果は "Alien_"
echo str_pad($input,  3, "*");                 // 結果は "Alien"

ワード検索

関数名アルファベット別

最終更新一覧

●stristr
　大文字小文字を区別せず文字列を検索し、ヒット箇所以降（あるいは以前）の文字列を返却

●stripslashes
　バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

●stripos
　大文字小文字を区別せずに文字列が最初に現れる位置を取得する

●stripcslashes
　addcslashes() でクォートされた文字列をアンクォートする

●strip_tags
　文字列から HTML と PHP のタグを除去して返却

●strcspn
　指定した文字が最初に現れる位置を調べる

●strcoll
　ロケールに基づいて2つの文字列を比較し同じか（あるいは大小）を判定する

●strcmp
　2つの文字列を比較し同じか（あるいは大小）を判定する

●strchr
　strstr() のエイリアス

●strcasecmp
　2つの文字列を比較（大文字小文字を区別せず同じとみなす）

カテゴリー一覧

PHP の振る舞いの変更
音声フォーマットの操作
認証サービス
コマンドライン関連
圧縮およびアーカイブ
暗号
データベース関連
日付および時刻関連
ファイルシステム
自然言語および文字エンコーディング
画像処理および作成
メール関連
数学
テキスト以外の MIME 型
プロセス制御
その他の基本モジュール
その他のサービス
検索エンジン用の拡張モジュール
サーバー固有のモジュール
セッション関連
テキスト処理
変数・データ型関連
ウェブサービス
Windows 用のモジュール
XML 操作
GUI用の拡張モジュール