DocumentationHSLReferenceFunctionHH\Lib\Str\pad_right

HH\Lib\Str\pad_right

Meta Engineer?

This is available as Str\pad_right in the www repository.

Returns the string padded to the total length (in bytes) by appending the $pad_string to the right

namespace HH\Lib\Str;

function pad_right(
  string $string,
  int $total_length,
  string $pad_string = ' ',
): string;

If the length of the input string plus the pad string exceeds the total length, the pad string will be truncated. If the total length is less than or equal to the length of the input string, no padding will occur.

To pad the string on the left, see Str\pad_left(). To pad the string to a fixed number of characters, see Str\pad_right_l().

Guide

String

Parameters

string $string
int $total_length
string $pad_string = ' '

Returns

string