指定した位置から、指定された文字数分の文字列を抜き出して返します。

文法

str.substr(start[, length])

引数	説明
start	文字の抜き出しの開始位置を指定します。 負の数が指定された場合、 strLengthが文字列長だとするとstrLength+startとして扱われます。 (例えば、startが-3の場合、strLength-3として扱われます。)
length	抜き出す文字数を指定します。

説明

startは、文字のインデックスを指定します。 先頭の文字のインデックスの値は0で、末尾の文字のインデックスは文字列長から1を引いた値になります。 substrはstart位置から、length文字数分の文字の抜き出しを行います。

startが正の数で、文字列長と同じ、またはそれ以上の値である場合、 substrは空文字列を返します。

startが負の数の場合、substrは文字列の終端からの文字インデックスとみなします。 startが負の数で且つabs(start)が文字列長よりも大きい場合、 substrはstartのインデックスを0として使用します。

lengthが0または負の数の場合、substrは空文字列を返します。 lengthが省略されると、substrは文字列の末尾まで文字を抜き出します。

例

substrの使用例

var str = "abcdefghij";

console.log("(1,2): "    + str.substr(1,2));   // (1,2): bc
console.log("(-3,2): "   + str.substr(-3,2));  // (-3,2): hi
console.log("(-3): "     + str.substr(-3));    // (-3): hij
console.log("(1): "      + str.substr(1));     // (1): bcdefghij
console.log("(-20, 2): " + str.substr(-20,2)); // (-20, 2): ab
console.log("(20, 2): "  + str.substr(20,2));  // (20, 2):

仕様

ブラウザ互換性

デスクトップ

機能	Chrome	Firefox (Gecko)	IE	Opera	Safari
基本	◯	◯	◯	◯	◯

モバイル

機能	Android	Chrome for Android	Firefox Mobile	IE Mobile	Opera Mobile	Safari Mobile
基本	◯	◯	◯	◯	◯	◯

関連項目

• String.prototype.slice()
• String.prototype.substring()

 Back to top