Manual

Reference

Modules

  • A • B • C • D • E
  • F • G • H • I • L
  • M • N • O • P • S
  • T • U • X

Tools

substr

Perl 5 version 26.0 documentation
Go to top
Show recent pages
Recently read

substr

Perl functions A-Z | Perl functions by category | The 'perlfunc' manpage
  • substr EXPR,OFFSET,LENGTH,REPLACEMENT

  • substr EXPR,OFFSET,LENGTH
  • substr EXPR,OFFSET

    Extracts a substring out of EXPR and returns it. First character is at offset zero. If OFFSET is negative, starts that far back from the end of the string. If LENGTH is omitted, returns everything through the end of the string. If LENGTH is negative, leaves that many characters off the end of the string.

    1.     my $s = "The black cat climbed the green tree";
    2.     my $color  = substr $s, 4, 5;      # black
    3.     my $middle = substr $s, 4, -11;    # black cat climbed the
    4.     my $end    = substr $s, 14;        # climbed the green tree
    5.     my $tail   = substr $s, -4;        # tree
    6.     my $z      = substr $s, -4, 2;     # tr

    You can use the substr function as an lvalue, in which case EXPR must itself be an lvalue. If you assign something shorter than LENGTH, the string will shrink, and if you assign something longer than LENGTH, the string will grow to accommodate it. To keep the string the same length, you may need to pad or chop your value using sprintf.

    If OFFSET and LENGTH specify a substring that is partly outside the string, only the part within the string is returned. If the substring is beyond either end of the string, substr returns the undefined value and produces a warning. When used as an lvalue, specifying a substring that is entirely outside the string raises an exception. Here's an example showing the behavior for boundary cases:

    1.     my $name = 'fred';
    2.     substr($name, 4) = 'dy';         # $name is now 'freddy'
    3.     my $null = substr $name, 6, 2;   # returns "" (no warning)
    4.     my $oops = substr $name, 7;      # returns undef, with warning
    5.     substr($name, 7) = 'gap';        # raises an exception

    An alternative to using substr as an lvalue is to specify the replacement string as the 4th argument. This allows you to replace parts of the EXPR and return what was there before in one operation, just as you can with splice.

    1.     my $s = "The black cat climbed the green tree";
    2.     my $z = substr $s, 14, 7, "jumped from";    # climbed
    3.     # $s is now "The black cat jumped from the green tree"

    Note that the lvalue returned by the three-argument version of substr acts as a 'magic bullet'; each time it is assigned to, it remembers which part of the original string is being modified; for example:

    1.     my $x = '1234';
    2.     for (substr($x,1,2)) {
    3.         $_ = 'a';   print $x,"\n";    # prints 1a4
    4.         $_ = 'xyz'; print $x,"\n";    # prints 1xyz4
    5.         $x = '56789';
    6.         $_ = 'pq';  print $x,"\n";    # prints 5pq9
    7.     }

    With negative offsets, it remembers its position from the end of the string when the target string is modified:

    1.     my $x = '1234';
    2.     for (substr($x, -3, 2)) {
    3.         $_ = 'a';   print $x,"\n";    # prints 1a4, as above
    4.         $x = 'abcdefg';
    5.         print $_,"\n";                # prints f
    6.     }

    Prior to Perl version 5.10, the result of using an lvalue multiple times was unspecified. Prior to 5.16, the result with negative offsets was unspecified.