PHP substr() Function

Syntax of substr() in PHP

The substr() function in PHP has the following syntax:

• $string (required):

  This is the input string from which you want to extract a substring.

• $start (required):

  This parameter specifies the starting position from where the substring extraction should begin. It is a 0-based index, meaning the first character of the string is at position 0, the second at position 1, and so on. Negative values count from the end of the string.

• $length (optional):

  This parameter indicates the length of the substring to be extracted. If provided, the function will extract the number of characters specified by this length. If not provided, the function will extract characters from the starting position to the end of the string.

Parameters of substr() in PHP

1. string $string (required):

   This is the input string from which you want to extract a substring. It's the string you want to operate on.

2. int $start (required):

   This parameter specifies the starting position from where the substring extraction should begin. It is a 0-based index, meaning the first character of the string is at position 0, the second at position 1, and so on. Negative values count from the end of the string.

3. ?int $length (optional):

   This parameter indicates the length of the substring to be extracted. If provided, the function will extract the number of characters specified by this length. If not provided, the function will extract characters from the starting position to the end of the string.

The function returns the extracted substring as a string. If any of the parameters are invalid, such as a negative length or a starting position beyond the length of the string, the function will return false.

Return Value of substr() in PHP

The substr() function in PHP returns a portion of the input string based on the specified starting position and, optionally, the length of the substring. The return value can vary based on different scenarios:

1. If the function successfully extracts the substring:

• If the $length parameter is provided and the substring is successfully extracted within the valid range of the string, the function returns the extracted substring as a new string.
• If the $length parameter is omitted, the function returns the substring starting from the specified position and extending to the end of the input string.

2. If the starting position is beyond the length of the input string:

• If the starting position provided by $start is greater than or equal to the length of the input string, the function returns an empty string (""). This is because there are no characters to extract beyond that point.

3. If the function encounters errors:

• If any of the parameters are invalid, such as a negative length or a starting position beyond the length of the string, the function returns false.

Examples of substr() in PHP

Simple PHP substr() Function Example

Here's a simple example of using the substr() function in PHP along with an explanation:

Explanation:

• The $inputString variable contains the string "Hello, World!" that we want to operate on.
• The $startPosition variable is set to 7, which means we want to start extracting the substring from the character at index 7, which is 'W' in "Hello, World!".
• The $length variable is set to 5, indicating that we want to extract 5 characters from the starting position.
• The substr() function is used to extract the substring. It takes the $inputString, $startPosition, and $length as arguments. In this case, it extracts the substring "World".
• The echo statements are used to display the original string and the extracted substring.

Run the above code in your editor for a better and clearer explanation.

Using the start parameter with different positive and negative numbers

Let's explore how the start parameter works with different positive and negative numbers in PHP's substr() function, along with explanations for each scenario:

The PHP code extracts substrings from "Hello, World!" using substr(). Positive start (7) gives "World!" from the string. Negative start (-6) counts from the end, still yielding "World!". The examples highlight how different start positions affect substring extraction.

Run the above code in your editor for a better and clearer explanation.

Using the start and length parameters with different positive and negative numbers

• Positive Start and Positive Length:

  Here, a positive start (7) indicates starting from 'W'. A positive length (5) specifies to extract 5 characters. The result is "World!".

• Negative Start and Positive Length:

  Negative start (-6) counts from the end, starting from 'W'. The positive length (5) specifies to extract 5 characters from that position. The result remains "World!".

Run the above code in your editor for a better and clearer explanation.