Anonymous user / Log In Register
Wallet: 3.00
Daily Credits:
1.20 / 1.20

PHP Functions Online


(PHP 4, PHP 5)

substrReturn part of a string

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

Checkout ? #

Item Description Item Price Your Price

Preview #

${{ }} = {{ variable.param|getValue:variable.form:true }};
{{ call.result}} = ;

Description #

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

Returns the portion of string specified by the start and length parameters.

Parameters #


The input string. Must be one character or longer.


If start is non-negative, the returned string will start at the start'th position in string, counting from zero. For instance, in the string 'abcdef', the character at position 0 is 'a', the character at position 2 is 'c', and so forth.

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.

Example #1 Using a negative start

substr("abcdef", -1);    // returns "f"
$rest substr("abcdef", -2);    // returns "ef"
$rest substr("abcdef", -31); // returns "d"


If length is given and is positive, the string returned will contain at most length characters beginning from start (depending on the length of string).

If length is given and is negative, then that many characters will be omitted from the end of string (after the start position has been calculated when a start is negative). If start denotes the position of this truncation or beyond, false will be returned.

If length is given and is 0, FALSE or NULL an empty string will be returned.

If length is omitted, the substring starting from start until the end of the string will be returned.

Example #2 Using a negative length

substr("abcdef"0, -1);  // returns "abcde"
$rest substr("abcdef"2, -1);  // returns "cde"
$rest substr("abcdef"4, -4);  // returns false
$rest substr("abcdef", -3, -1); // returns "de"

Return Values #

Returns the extracted part of string; or FALSE on failure, or an empty string.

Errors #

Returns FALSE on error.

(substr('a'1)); // bool(false)

Examples #

Example #3 Basic substr() usage

echo substr('abcdef'1);     // bcdef
echo substr('abcdef'13);  // bcd
echo substr('abcdef'04);  // abcd
echo substr('abcdef'08);  // abcdef
echo substr('abcdef', -11); // f

// Accessing single characters in a string
// can also be achieved using "square brackets"
$string 'abcdef';
$string[0];                 // a
echo $string[3];                 // d
echo $string[strlen($string)-1]; // f


Changelog #

Version Description
5.2.2 - 5.2.6 If the start parameter indicates the position of a negative truncation or beyond, false is returned. Other versions get the string from start.

See Also #