PHP substr() Function
Overview
In PHP, substr() is a built-in function used to extract a portion of a string. It enables developers to retrieve a specific substring based on starting and optionally ending positions. The function takes the original string and the desired start position as arguments, and can also take an optional length parameter to determine the length of the extracted substring. This function is useful for manipulating strings, such as extracting portions of text or trimming unwanted characters.
Transform Your Career
Choose from our industry-leading programs designed for career success
Modern Software and AI Engineering Program
Master full-stack development with AI integration
+1000 moreModern Data Science and ML with specialisation in AI
Advanced data science techniques with AI specialization
+1000 moreAdvanced AIML with Specialisation in Agentic AI
Deep dive into AIML with focus on Agentic systems
+1000 moreDevOps, Cloud & AI Platform Engineering
Build and manage AI-powered cloud infrastructure
+1000 moreAI Engineering Advanced Certification by IIT-Roorkee
Premier AI engineering certification from IIT-Roorkee
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.
Scaler Placement Report and Statistics
Scaler learners achieved 2.5x salary growth with average post-Scaler CTC reaching ₹23L.
Parameters of substr() in PHP
-
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.
-
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.
-
?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:
- 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.
- 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.
- 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.
Conclusion
- The substr() function is used to extract a portion of a string based on specified starting and optional ending positions.
- substr() is versatile for tasks like truncating long strings, extracting specific data (e.g., dates from timestamps), or parsing information from text.
- A negative start position counts from the end of the string. For example, -1 refers to the last character.
- substr() is a valuable tool for manipulating text-based data, whether it's for data cleaning, data extraction, or generating customized outputs.
Google
Amazon
Microsoft
Flipkart
Adobe1200+ more