Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

strpos(3) [php man page]

STRPOS(3)								 1								 STRPOS(3)

strpos - Find the position of the first occurrence of a substring in a string

SYNOPSIS
mixed strpos (string $haystack, mixed $needle, [int $offset]) DESCRIPTION
Find the numeric position of the first occurrence of $needle in the $haystack string. PARAMETERS
o $haystack - The string to search in. o $needle - If $needle is not a string, it is converted to an integer and applied as the ordinal value of a character. o $offset - If specified, search will start this number of characters counted from the beginning of the string. Unlike strrpos(3) and strri- pos(3), the offset cannot be negative. RETURN VALUES
Returns the position of where the needle exists relative to the beginning of the $haystack string (independent of offset). Also note that string positions start at 0, and not 1. Returns FALSE if the needle was not found. Warning This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function. EXAMPLES
Example #1 Using === <?php $mystring = 'abc'; $findme = 'a'; $pos = strpos($mystring, $findme); // Note our use of ===. Simply == would not work as expected // because the position of 'a' was the 0th (first) character. if ($pos === false) { echo "The string '$findme' was not found in the string '$mystring'"; } else { echo "The string '$findme' was found in the string '$mystring'"; echo " and exists at position $pos"; } ?> Example #2 Using !== <?php $mystring = 'abc'; $findme = 'a'; $pos = strpos($mystring, $findme); // The !== operator can also be used. Using != would not work as expected // because the position of 'a' is 0. The statement (0 != false) evaluates // to false. if ($pos !== false) { echo "The string '$findme' was found in the string '$mystring'"; echo " and exists at position $pos"; } else { echo "The string '$findme' was not found in the string '$mystring'"; } ?> Example #3 Using an offset <?php // We can search for the character, ignoring anything before the offset $newstring = 'abcdef abcdef'; $pos = strpos($newstring, 'a', 1); // $pos = 7, not 0 ?> NOTES
Note This function is binary-safe. SEE ALSO
stripos(3), strrpos(3), strripos(3), strstr(3), strpbrk(3), substr(3), preg_match(3). PHP Documentation Group STRPOS(3)

Check Out this Related Man Page

STRRPOS(3)								 1								STRRPOS(3)

strrpos - Find the position of the last occurrence of a substring in a string

SYNOPSIS
int strrpos (string $haystack, string $needle, [int $offset]) DESCRIPTION
Find the numeric position of the last occurrence of $needle in the $haystack string. PARAMETERS
o $haystack - The string to search in. o $needle - If $needle is not a string, it is converted to an integer and applied as the ordinal value of a character. o $offset - If specified, search will start this number of characters counted from the beginning of the string. If the value is negative, search will instead start from that many characters from the end of the string, searching backwards. RETURN VALUES
Returns the position where the needle exists relative to the beginnning of the $haystack string (independent of search direction or off- set). Also note that string positions start at 0, and not 1. Returns FALSE if the needle was not found. Warning This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function. CHANGELOG
+--------+---------------------------------------------------+ |Version | | | | | | | Description | | | | +--------+---------------------------------------------------+ | 5.0.0 | | | | | | | The $needle may now be a string of more than one | | | character. | | | | +--------+---------------------------------------------------+ EXAMPLES
Example #1 Checking if a needle is in the haystack It is easy to mistake the return values for "character found at position 0" and "character not found". Here's how to detect the difference: <?php $pos = strrpos($mystring, "b"); if ($pos === false) { // note: three equal signs // not found... } ?> Example #2 Searching with offsets <?php $foo = "0123456789a123456789b123456789c"; var_dump(strrpos($foo, '7', -5)); // Starts looking backwards five positions // from the end. Result: int(17) var_dump(strrpos($foo, '7', 20)); // Starts searching 20 positions into the // string. Result: int(27) var_dump(strrpos($foo, '7', 28)); // Result: bool(false) ?> SEE ALSO
strpos(3), stripos(3), strripos(3), strrchr(3), substr(3). PHP Documentation Group STRRPOS(3)
Man Page