substr()

string substr ( string $string, int $start [ , int $length ] )

Description

substr() returns the portion of string specified by the start and length parameters

※ available F/W version : all

Parameters

$string - the input string
$start - If $start is non-negative, the returned string will start at the $start’th position in string
If $start is negative, the returned string will start at the $start’th character from the end of string
If $string is less than or equal to $start characters long, FALSE will be returned
$length - If $length is positive, the string returned will contain at most length characters beginning from start
If $length is negative, the absolute value will be omitted from the end of string (after the start position has been calculated when a start is negative)
If $length is given and is 0, an empty string will be returned
If $length is omitted, the substring starting from $start until the end of string will be returned

Return values

Returns the extracted part of string on success, FALSE on failure.

Example

<?php
$str = "abcdef";
$ret = substr($str, 2); echo "$ret\r\n";       // OUTPUT: cdef
$ret = substr($str, -1); echo "$ret\r\n";      // OUTPUT: f
$ret = substr($str, -2); echo "$ret\r\n";      // OUTPUT: ef
$ret = substr($str, 2, 3); echo "$ret\r\n";    // OUTPUT: cde
$ret = substr($str, -3, 1); echo "$ret\r\n";   // OUTPUT: d
$ret = substr($str, 0, -1); echo "$ret\r\n";   // OUTPUT: abcde
$ret = substr($str, 2, -1); echo "$ret\r\n";   // OUTPUT: cde
$ret = substr($str, 4, -4); echo "$ret\r\n";   // OUTPUT: 0
$ret = substr($str, -3, -1); echo "$ret\r\n";  // OUTPUT: de

$ret = substr($str, 9); 
if($ret === FALSE) echo "returned FALSE\r\n";  // OUTPUT: returned FALSE
?>

Remarks

This function is identical to the PHP group’s substr() function.

< strtoupper()

substr_replace() >