関数 str_pad

関数 str_pad は、文字列を指定された長さまで別の 文字列でパディングします。最初のパラメータは 文字列を受け取り、2番目のパラメータは文字列を パディングする長さ(文字数)、3番目の パラメータは文字列を埋めるための文字列です。

4番目のオプションパラメータは、 どの側から文字列を埋めるかを指定します。このパラメータ は以下の値を受け取ります: STR_PAD_LEFT - 文字列を左側からパディング、 STR_PAD_RIGHT - 文字列を右側からパディング(これがデフォルト値です)。

構文

phpstr_pad(string $string, int $length, string $pad_string = " ", int $pad_type = STR_PAD_RIGHT): string

例

文字列を文字 '+' で 埋めて、文字列の長さが 10 文字になるようにしましょう:

php<?php
  $arr = 'abcde';
  echo str_pad($arr, 10, '+');
?>

コードの実行結果:

php'abcde+++++'

例

今度は文字列を右ではなく、左から埋めます:

php<?php
  $arr = 'abcde';
  echo str_pad($arr, 10, '+', STR_PAD_LEFT);
?>

コードの実行結果:

php'+++++abcde'

関連項目

  • 関数 array_pad,
    配列を指定された要素でパディングする関数
  • 関数 array_fill,
    配列を指定された値で埋める関数
  • 関数 str_repeat,
    文字列を指定された回数だけ繰り返す関数