【PHP】文字列を指定した長さまで埋めることができるstr_pad関数を解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、10年目エンジニアです。

この記事では、 PHPで文字列を指定した長さまで埋めることができるstr_pad関数について

str_pad関数とは
str_pad関数を使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
str_pad関数とは
str_pad関数を解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：str_pad関数を使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
PHPのバージョン	8.0.3
XAMPPのバージョン	8.0.3

PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。

【XAMPP】インストールするやり方を解説します

str_pad関数とは

str_pad関数とは、文字列に左、右または両側に指定した長さまで文字で埋めた文字列を返す関数です。

str_pad関数の使い方は以下になります。

$result = str_pad('aa', 4, 'x', STR_PAD_LEFT);

1	$result = str_pad('aa', 4, 'x', STR_PAD_LEFT);

指定した引数は以下の意味をします。

第一引数（必須）	埋めたい文字列
第二引数（必須）	合計で何文字にするか
第三引数（任意）	埋める文字
第四引数（任意）	どこを埋めるか右埋め：STR_PAD_RIGHT 左埋め：STR_PAD_LEFT 両埋め：STR_PAD_BOTH

上記のサンプルだと、変数resultには「xxaa」という文字列が返ります。

第二引数に指定した数が、

負の数
第一引数の文字数以下

の場合は、第一引数に指定した文字列をそのまま返します。

第三引数と第四引数を指定しなかった場合のデフォルト値は以下になります。

第三引数	半角空白
第四引数	STR_PAD_RIGHT

では、次の章で実際に使ってみます。

str_pad関数を解説するプログラムの概要

str_pad関数を解説するプログラムでは

オプション指定なし
オプション指定あり左埋め
オプション指定あり右埋め
オプション指定あり両埋め

の4パターンで同じ文字列に対してstr_pad関数で文字列を埋め、結果を表示させます。

phpプログラムは

C:\xampp\htdocs

配下に、【str_pad_sample.php】というファイル名で格納しています。
PHPのstr_pad関数の解説

PHPサンプルプログラム

<?php
	$input_str = 'ABC';
	$pad = '.';
	print('入力文字列：'.$input_str.'<br >');
	print('埋める文字：'.$pad.'<br ><br >');

	print('■str_padサンプル　オプション指定なし<br >');
	$no_option = str_pad($input_str, 8);
	var_dump($no_option);
	print('<br ><br >');

	print('■str_padサンプル　オプション指定あり左埋め<br >');
	$option_left_pad = str_pad($input_str, 8, $pad, STR_PAD_LEFT);
	var_dump($option_left_pad);
	print('<br ><br >');

	print('■str_padサンプル　オプション指定あり右埋め<br >');
	$option_right_pad = str_pad($input_str, 8, $pad, STR_PAD_RIGHT);
	var_dump($option_right_pad);
	print('<br ><br >');

	print('■str_padサンプル　オプション指定あり両埋め<br >');
	$option_both_pad = str_pad($input_str, 8, $pad, STR_PAD_BOTH);
	var_dump($option_both_pad);
	print('<br ><br >');
?>

<?php

$input_str = 'ABC';

$pad = '.';

print('入力文字列：'.$input_str.' ');

print('埋める文字：'.$pad.' ');

print('■str_padサンプル　オプション指定なし ');

$no_option = str_pad($input_str, 8);

var_dump($no_option);

print(' ');

print('■str_padサンプル　オプション指定あり左埋め ');

$option_left_pad = str_pad($input_str, 8, $pad, STR_PAD_LEFT);

var_dump($option_left_pad);

print(' ');

print('■str_padサンプル　オプション指定あり右埋め ');

$option_right_pad = str_pad($input_str, 8, $pad, STR_PAD_RIGHT);

var_dump($option_right_pad);

print(' ');

print('■str_padサンプル　オプション指定あり両埋め ');

$option_both_pad = str_pad($input_str, 8, $pad, STR_PAD_BOTH);

var_dump($option_both_pad);

print(' ');

実行結果

XAMPPを起動して、【http://localhost/str_pad_sample.php】のURLにアクセスします。

XAMPPでPHPの動かし方については、こちらの記事をご参考ください。

XAMPPでPHPの動かし方を解説します

PHPのstr_pad関数の解説

オプションを指定しているものは、指定した文字と位置で文字埋めの処理がされていることが確認できました。

「オプション指定なし」が画面表示ではよく分からないため

Ctrlキー+Shiftキー+Iキー
F12キー

のどちらかを押してデベロッパーツールで表示確認をします。
PHPのstr_pad関数の解説
オプションを指定しない場合は、空白で埋められていることが確認できました。

まとめ：str_pad関数を使ってみよう！

以上がstr_pad関数についての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ