str_pad()

1. 定义

向指定字符串填充另一个字符串的特定长度的内容,返回填充后的字符串。

2. 语法

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

3. 参数说明

参数 可选性 数据类型 描述
$input 必需 字符串 将被填充内容的字符串
$pad_length 必需 整型 填充后的字符串长度,如果该长度不大于$input的长度,将不填充内容
$pad_string 可选 字符串 要填充的内容
$pad_type 可选 整型或常量 填充方向

其中$pad_type有三个可能值:

  • STR_PAD_RIGHT:默认值,向字符串右端填充
  • STR_PAD_LEFT:向字符串左端填充
  • STR_PAD_BOTH:向字符串两端填充

4. 示例

<?php

// str_pad()
// 向指定字符串填充另一个字符串的特定长度的内容,返回填充后的字符串

$input = 'hello, world';
$pad_length = 16;
$pad_string = ' add';
$res = str_pad($input, $pad_length, $pad_string, STR_PAD_RIGHT);
var_dump($res);// 输出:string(16) "hello, world add"

// 填充后长度超过指定长度时,超出的部分将被截断
$pad_string = ' add data';
$res = str_pad($input, $pad_length, $pad_string, STR_PAD_RIGHT);
var_dump($res);// 输出:string(16) "hello, world add"

// 填充后总长度小于等于原字符串的长度时,不执行填充操作
$pad_length = 11;
$pad_string = ' add';
$res = str_pad($input, $pad_length, $pad_string, STR_PAD_RIGHT);
var_dump($res);// 输出:string(12) "hello, world"