Updated May 12, 2023
PHP substr_count() Function
The substr_count() function of PHP programming language is also one of the important built-in function and it is very helpful to count that how many numbers of substrings occurs in a specifically given string. The function will provide a search option for some given substring which is within the given index range. The substr_count() is case sensitive that means “abc” substring value is not present in the string “acbcab”. If (start+length)’s value which is specified for the search will exceed the size of the string passed and it will return the warning message/messages to the user.
Syntax of substr_count() Function in PHP
Below is the syntax:
Substr_count($string1, $substring1, $start1, $length1)
Parameters of substr_count() Function
Explanation of the Parameters of substr_count() function:
1. $string1: The string1 parameter of the substr_count() of the PHP Programming language helps in passing the parameter which is actually the one in which substring’s occurrence/occurrences will be counted. This string1 parameter is one of the mandatory parameter of the substr_count() function. It is needed to make the substr_count() to work.
2. $substring1: The substring1 parameter of the substr_count() of the PHP Programming Language helps in passing the substring in which the string searching and the occurrence will be counted and will be returned. This substring1 parameter must be supplied because it is a mandatory parameter.
3. $start1: The start1 parameter of the substr_count() of the PHP Programming Language will help in some value is passed to this parameter but it is not a mandatory parameter of the PHP substr_count() function. It is an optional parameter. After the parameter is passed with the value then the search will be completed and starts from the starting position instead of the whole string search for different occurrences of the substring.
4. $length1: The length1 parameter of the substr_count() of the PHP Programming Language will help in the limiting the search operation/operations which actually starts from start to the start+length position. If the start+length value will increase the string length, then by providing/generating a warning message. This parameter is not at all a mandatory parameter. It is an optional parameter.
How substr_count() Function Work in PHP?
The substr_count() function works by returning different types of values which are shown below in different types of cases.
- The given substring occurs/appears so many times only if the string is having some optional parameters which is not at all passed.
- The substring will appear in the string between the starting point of the string to the ending point of the string so many times when the string value is passed as a parameter.
- The substring will appear inside of the string/in the string in between the starting of the string and the start+length of the string’s position when the both length and start parameters will be passed.
- The substr_count() function basically works by counting the occurrence/occurrences of the specific substring or sub strings inside of the specific big string/other. The substr_count() will provide options to search for the specific substring in some index range.
Examples to Implement of PHP substr_count()
Below are the examples of substr_count() function:
Example #1
This is the example of implementation of the substr_count() only with usage of two mandatory parameters. They are the original string and the substring. The substring will be searched inside of the original source string inside of the substr_count() to know how many times the substring is occurred.
Code:
<?php
$str1 = "pavan sake pavan";
echo "<hr>";
echo "The Original Source String is :: $str1";
echo "<br>";
$substring1 = "pavan";
echo "The Sub String which is to be searched in the original source string :: $substring1";
echo "<br>";
echo "The number of occurrences of the substring ($substring1) is :: ";
echo substr_count($str1, $substring1);
echo "<hr>";
?>
Output:
Example #2
This is the example of implementing the substr_count() function when the start parameter is passed in it.
Code:
<?php
echo "This is the example of implementing start1 variable/parameter inside of substring_count() function";
echo "<br>";
$str1 = "pavankumar sake pavan";
echo "<hr>";
echo "The Original Source String is :: $str1";
echo "<br>";
$substring1 = "pavan";
echo "The Sub String which is to be searched in the original source string :: $substring1";
echo "<br>";
echo "The number of occurrences of the substring ($substring1) after the string length 6 is :: ";
echo substr_count($str1, $substring1, 6);
echo "<hr>";
?>
Output:
Example #3
This is the example of implementing the substr_count() when both the start1 and length1 parameters are passed. This will bypass the search 2 times.
Code:
<?php
echo "This is the example of implementing length1 and start1 variables/parametersinside of substring_count() function :: ";
echo "<br>";
$str1 = "pavankumar sake pavan sake sakesakesakesake";
echo "<hr>";
echo "The Original Source String of str1 variable is :: $str1";
echo "<br>";
$substring1 = "pavan";
echo "The Sub String substring1 variable which is to be searched in the original source string :: $substring1";
echo "<br>";
echo "The number of occurrences of the substring1 ($substring1) after the start value 6 and length value 2 is :: ";
echo substr_count($str1, $substring1, 6, 2);
echo "<hr>";
?>
Output:
Example #4
This is the example of implementing the substr_count() function when the string length exceeds the start1+length1 parameters value. This will produce a warning type of message. Check out the output so that you will understand the substr_count() function.
Code:
<?php
echo "This is the example of implementing length1 and start1 variables/parameters inside of substring_count() function for warning message if length exceeds the string length :: ";
echo "<br>";
$str1 = "pavankumar sake pavan sake sakesakesakesake";
echo "<hr>";
echo "The Original Source String of str1 variable is :: $str1";
echo "<br>";
$substring1 = "pavan";
echo "The Sub String substring1 variable which is to be searched in the original source string :: $substring1";
echo "<br>";
echo "<hr>";
echo "The number of occurrences of the substring1 ($substring1) after the start value 6 and length value 2 is :: ";
echo "<hr>";
echo substr_count($str1, $substring1, 6, 121);
echo "<hr>";
?>
Output:
Conclusion
I hope you learned what is the definition of the PHP substr_count() function along with substr_count()’s syntax and parameter, how the PHP substr_count() function works in the PHP Programming language along with various examples to understand the substr_count() concept better and so easily.
Recommended Article
This is a guide to the PHP substr_count(). Here we discuss the Introduction and its parameters of PHP substr_count() Function along with examples and Code Implementation. You can also go through our other suggested articles to learn more-