関数の概要
PHPの str_repeat は、指定した文字列を任意の回数だけ繰り返して連結した新しい文字列を返す関数です。文字列操作で「同じ文字列を繰り返したい」場合に便利で、例えば区切り文字の生成やパターン文字列の作成などに用いられます。
パラメータの説明
string $input:繰り返したい元の文字列を指定します。int $multiplier:何回繰り返すかを整数で指定します。0を指定すると空文字列が返ります。
戻り値
str_repeat は、元の文字列を指定回数繰り返した新しい文字列を返します。$multiplier が 0 または負の数の場合は空文字列を返します。
使用例
基本的な使い方
<?php
echo str_repeat("A", 5); // 出力: AAAAA
?>
「A」という文字を5回繰り返して出力しています。
区切り線の生成
<?php
echo "<hr>";
echo str_repeat("-", 20);
echo "<hr>";
?>
横線の代わりにハイフンを20回並べて簡易的な区切り線として利用しています。
繰り返し文字列を変数で利用
<?php
$indent = str_repeat(" ", 4);
echo $indent . "インデントされたテキスト";
?>
HTMLの空白(ノーブレークスペース)を4つ繰り返してインデント表現に使う例です。
関連する関数
str_pad:指定した長さまで文字列を埋めて調整するsubstr:文字列の一部を抜き出すstr_repeat:文字列を繰り返す(本記事の関数)
まとめ
str_repeat は指定した文字列を簡単に繰り返せる便利な関数です。繰り返し文字列の作成や画面出力の装飾など、幅広い用途で使えます。パラメータの指定に注意し、初心者でもすぐに扱えるシンプルな関数として覚えておきましょう。
