PHP str_pad() Function

PHP

PHP str_pad() - Pad String to Length

Learn PHP str_pad() function. Pad a string to a specified length with a given character.

Introduction

When working with strings in PHP, sometimes you need to ensure a string has a specific length by adding extra characters to its start, end, or both sides. The str_pad() function in PHP helps you pad a string to a specified length by adding a specific string (often a space or zero) around it. This is especially useful for formatting output, aligning text, creating fixed-width strings, or preparing data for display or storage.

Prerequisites

  • Basic knowledge of PHP syntax
  • Understanding of strings in PHP
  • PHP installed on your local environment or access to a PHP-enabled server

Setup Steps

  1. Ensure PHP (version 4 or above) is installed on your machine. You can check by running php -v in your command line.
  2. Create a PHP script file, for example, str_pad_demo.php.
  3. Open your favorite code editor and start writing your PHP code using the str_pad() function as shown in the examples below.
  4. Run the PHP script via the command line or through your web server to see the output.

What is PHP str_pad()?

The str_pad() function pads a string to a new length with another string, optionally from the left, right, or both sides.

Syntax

str_pad(string $input, int $pad_length, string $pad_string = " ", int $pad_type = STR_PAD_RIGHT): string
  • $input - The input string to pad.
  • $pad_length - The desired length after padding.
  • $pad_string - The string to pad with. Default is space (" ").
  • $pad_type - How to pad: STR_PAD_RIGHT (default), STR_PAD_LEFT, or STR_PAD_BOTH.

Examples Explained

Example 1: Right Padding with Spaces

<?php
$text = "PHP";
$padded = str_pad($text, 10);
echo "[" . $padded . "]";
?>

Output: [PHP ]

The input string "PHP" is padded with spaces on the right to reach a total length of 10 characters.

Example 2: Left Padding with Zeros

<?php
$number = "123";
$padded = str_pad($number, 6, "0", STR_PAD_LEFT);
echo $padded;
?>

Output: 000123

Here, the string "123" is padded with "0" characters to the left until the length reaches 6.

Example 3: Pad Both Sides with Asterisks

<?php
$text = "Center";
$padded = str_pad($text, 12, "*", STR_PAD_BOTH);
echo $padded;
?>

Output: ***Center****

The string is padded with asterisk characters on both sides to make the total length 12; if uneven padding is required, PHP pads the right side more.

Example 4: Padding with Multi-character String

<?php
$text = "Pad";
$padded = str_pad($text, 10, "ab", STR_PAD_RIGHT);
echo $padded;
?>

Output: Padabababa

The pad_string can be longer than 1 character; PHP repeats it until the total length is met or exceeded and then truncated.

Best Practices

  • Always specify the $pad_length to avoid unexpected results.
  • Choose the correct $pad_type (STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH) based on your alignment needs.
  • Be mindful when using multi-character $pad_string - strings will be truncated, which can sometimes lead to unexpected characters at the end.
  • Use trim() with the padded string if you want to remove the added padding later.
  • For numerical padding, using zero-padding is a common practice to normalize numbers for sorting or display.

Common Mistakes

  • Not specifying pad length: If $pad_length is less than or equal to the original string length, no padding is applied.
  • Wrong pad type: Forgetting to use STR_PAD_LEFT or STR_PAD_BOTH when needed results in default right padding only.
  • Using empty pad string: Providing an empty $pad_string leads to warnings or no padding.
  • Assuming pad string repeats fully: When the pad string length doesn't evenly divide the padding length, PHP truncates the last repetition.

Interview Questions

Junior Level

  • Q1: What is the default padding type used by str_pad()?
    A1: STR_PAD_RIGHT is the default padding type.
  • Q2: How do you pad a string to length 8 with zeros on the left using str_pad()?
    A2: Use str_pad($string, 8, "0", STR_PAD_LEFT);
  • Q3: What happens if the padding length is less than the string length?
    A3: No padding is added; the original string is returned.
  • Q4: Can you use multi-character strings to pad? Provide an example.
    A4: Yes, e.g., str_pad("test", 10, "ab");
  • Q5: Which parameter controls the total length after padding?
    A5: The $pad_length parameter.

Mid Level

  • Q1: Explain the difference between STR_PAD_LEFT and STR_PAD_BOTH.
    A1: STR_PAD_LEFT adds padding only to the left side whereas STR_PAD_BOTH pads both sides, distributing the padding.
  • Q2: How does str_pad() handle padding strings longer than one character?
    A2: It repeats the padding string until the length is met or exceeded, truncating the excess characters.
  • Q3: In what scenarios is str_pad() commonly used?
    A3: For aligning text output, creating fixed-width fields, zero-padding numbers, or formatting data reports.
  • Q4: What will the following output be?
    echo str_pad("Align", 9, "*", STR_PAD_BOTH);
    A4: **Align**, with 4 asterisks total, two on each side.
  • Q5: Is it possible to use str_pad() with multi-byte character strings? What must be considered?
    A5: str_pad() is not multi-byte safe; use with caution for UTF-8 strings as it may break characters.

Senior Level

  • Q1: How would you implement a custom padding function that supports multi-byte (UTF-8) strings with padding?
    A1: Use mb_strlen() for measuring string length and custom concatenation to pad UTF-8 strings accurately.
  • Q2: Describe how str_pad() internally calculates padding when the $pad_string length does not divide padding length evenly.
    A2: It repeats the pad string enough times to exceed the required padding then truncates the last repetition to exactly fit the length.
  • Q3: Can str_pad() be used for binary data padding? Why or why not?
    A3: It's not recommended since str_pad() operates on strings and may modify binary sequences unintentionally.
  • Q4: How might you optimize padding for large text outputs where performance is critical?
    A4: Precompute pad strings when possible, avoid repeated calls, and use native str_pad() which is implemented in C for speed.
  • Q5: Explain how padding can aid in creating fixed-width data records for legacy database systems.
    A5: Padding aligns fields to fixed sizes, enabling predictable offsets in records, crucial for flat-file or fixed-length data tables.

Frequently Asked Questions (FAQ)

  • Q: What happens if $pad_string is an empty string?
    A: PHP issues a warning and no padding is applied.
  • Q: Can str_pad() truncate the original string if it's longer than $pad_length?
    A: No, it only pads if the string is shorter; otherwise, it returns the original string unmodified.
  • Q: How do I pad a string with spaces on both sides evenly?
    A: Use STR_PAD_BOTH as the padding type argument.
  • Q: Is str_pad() multi-byte safe?
    A: No, it can break multi-byte character strings like UTF-8. Use multi-byte string functions or custom implementations.
  • Q: How to remove padding added by str_pad()?
    A: Use trim(), ltrim(), or rtrim() depending on the padding direction and characters applied.

Conclusion

The PHP str_pad() function is a powerful and easy-to-use tool to add padding to strings for formatting and alignment purposes. Whether you need to pad with spaces, zeros, or custom characters, this function adapts to many use cases. By understanding its parameters and behavior, you can confidently implement fixed-width strings, prepare numeric data for display, or create aligned text outputs in your PHP applications.

Use the examples and best practices shared above to get the most out of str_pad(), and avoid common pitfalls by testing edge cases with your strings and padding options.