mb_str_pad

    (PHP 8 >= PHP 8.3.0)

    mb_str_pad — マルチバイト文字列を、特定の長さまで別のマルチバイト文字列で埋める

    説明

    mb_str_pad(
        string $string,
        int $length,
        string $pad_string = " ",
        int $pad_type = STR_PAD_RIGHT,
        ?string $encoding = null
    ): string

    この関数は文字列 string の左、右または両側を指定した長さで埋めます。 長さは Unicode のコードポイント単位で決まります。 pad_string が指定されていない場合は、 string は空白で埋められ、それ以外の場合は、 pad_string からの文字で制限まで埋められます。

    パラメータ

    string

    入力文字列。

    length

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

    pad_string

    注意:

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

    pad_type

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

    encoding

    encoding パラメータには文字エンコーディングを指定します。省略した場合、もしくは null の場合は、 内部文字エンコーディングを使用します。

    戻り値

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

    例

    例1 mb_str_pad() の例

    <?php
    var_dump    (mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_RIGHT)); // string(18) "▶▶❤❓❇❤"
    var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_LEFT)); // string(18) "❤❓❇❤▶▶"
    var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_BOTH)); // string(18) "❤❓▶▶❤❓"

    var_dump(mb_str_pad("🎉", 3, "祝", STR_PAD_LEFT)); // string(10) "祝祝🎉"
    ?>

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top