【PHP】substr()で文字列の一部を取得する!

(この記事は2022年6月24日に投稿されました。)

PHPで文字列の一部を取得する関数として、substr()があります。

substr()とは指定した文字列の一部を切り取る関数になります。

「abcde」という文字列があったとしてそれにsubstr()を使用すると、自分の好きなところの一部を文字列として返されます。

しかし、全角文字列はバイト数が異なるため、切り取る長さによっては文字化けを起こしてしまいます。

また、int型の文字列を指定した場合でも、文字列の一部を切り取ることはできますが、string型になって返ってきますので注意が必要です。

そして、substr()は文字列はもちろん、指定した配列の値の一部を取得することも可能です。

今回はPHPのsubstr()で文字列の一部を取得する方法について紹介していきます。

この記事はこんな方におすすめ
・PHPである文字列の一部を取得したい人




substr()とは

冒頭でも言いましたが、substr()とは、文字列の一部を切り出す関数となります。

例えば、「abcdefg」という文字列にsubstr()を使用すると、「abc」や「bcdefg」のように文字列の一部を返り値として返すようになります。

また、切り出す部分は自分で調整することが可能です。

substr()の書き方

substr()の書き方は下記のようになります。

substr()のパラメータ

substr()のパラメータは下記のようになります。

  1. 対象の文字列(必須):
    逆に並び替えたい文字列を指定する
  2. 抜き出す文字の位置(必須):
    抜き出す文字の文字をインデックス指定する
  3. 抜き出す文字の長さ(任意):
    抜き出す文字の長さをインデックスで指定する

substr()は必須のパラメータとして「対象の文字列」と「抜き出す文字の位置」を指定することで使用することができます。

また、任意パラメータとして「抜き出す文字の長さ」を3つ目のパラメータに指定すると、切り出す文字列の長さを調整することができます。

substr()で文字列の一部を取得するサンプルコード

substr()で文字列の一部を取得するサンプルコードについてご紹介します。

ここでは下記の3つの場合でsubstr()を使用してみます。

  1. 文頭から文字列の一部を取得する場合
  2. 末尾から文字列の一部を取得する場合
  3. 日本語の文字列の一部を取得する場合

文頭から文字列の一部を取得する場合

文頭から文字列の一部を取得する場合に、substr()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

パラメータである「抜き出す文字の位置」に正の数を指定することで、文頭を先頭にして数えた位置までの文字列を取得することができます。

そのため、「Cut out this text!」の一部である「this text!」が表示され、「123456789」の一部である「456789」が表示されています。

Sossy

int型の文字列に対して、substr()を使用すると、int型ではなくstring型で返ってきますので注意してください!

末尾から文字列の一部を取得する場合

末尾から文字列の一部を取得する場合に、substr()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

パラメータである「抜き出す文字の位置」に負の数を指定することで、後ろから数えた位置を先頭にして文末までの文字列を取得することができます。

そのため、「Cut out this text!」の一部である「this text!」が表示され、「123456789」の一部である「456789」が表示されています。

全角文字列の一部を取得する場合

全角の文字列の一部を取得する場合に、substr()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

全角の文字列に使用すると、抜き出すことはできますが、抜き出す位置によっては文字化けになってしまいます。

そのため、substr()は全角文字列には不向きとなります。

Sossy

全角文字は1文字3バイトなので、「位置 × 3」にすると抜き出せますが、半角と混ざった文字列では対応が難しくなります。

抜き出す文字の長さを指定して文字列の一部を取得するサンプルコード

substr()に抜き出す文字の長さを指定して文字列の一部を取得するサンプルコードをご紹介します。

ここでは下記の2つの場合でsubstr()を使用してみます。

  1. 抜き出す文字の長さに正の整数を指定した場合
  2. 抜き出す文字の長さに負の整数を指定した場合

抜き出す文字の長さに正の整数を指定した場合

substr()の抜き出す文字の長さに正の整数を指定して、文字列の一部を取得してみます。

⚫︎ index.php

⚫︎ 実行結果

抜き出す文字の長さに正の整数を指定することで、抜き出した文字列の文頭から絶対値分の文字数を取得しています。

そのため、「Cut out this text!」の一部である「this」が表示され、「123456789」の一部である「4567」が表示されています。

Sossy

「Cut out this text!」→「this text!」→「this」となり、「123456789」→「456789」→「4567」となります。

抜き出す文字の長さに負の整数を指定した場合

substr()の抜き出す文字の長さに負の整数を指定して、文字列の一部を取得してみます。

⚫︎ index.php

⚫︎ 実行結果

抜き出す文字の長さに負の整数を指定することで、抜き出した文字列の文末から絶対値分の文字数をカットし、抜き出した文字列の文頭から先ほどカットした部分の前までの文字を取得しています。

そのため、「Cut out this text!」では「this」が表示され、「123456789」では「4567」が表示されています。

Sossy

「Cut out this text!」→「this text!」→「this」となり、「123456789」→「456789」→「456」となります。

substr()で配列の値の一部を取得するサンプルコード

substr()で配列の値の一部を取得するサンプルコードについてご紹介します。

ここでは、下記の2つの場合でsubstr()を使用してみます。

  1. 指定した配列の値の一部を取得する場合
  2. 指定した連想配列の値の一部を取得する場合

指定した配列の値の一部を取得する場合

指定した配列の値の一部を取得する場合にsubstr()を使用してみます。

ここでは、1次元配列と2次元配列の値の一部を取得してみます。

⚫︎ index.php

⚫︎ 実行結果

substr()によって指定した配列の値の一部を取得しています。

そのため、「English」の一部である「lish」、「technology」の一部である「hnology」が表示されています。

指定した連想配列の値の一部を取得する場合

指定した連想配列の値の一部を取得する場合にsubstr()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

substr()によって指定した連想配列の値の一部を取得しています。

そのため、「Science」の一部である「ence」が表示されています。

全角文字列の一部を正確に取得したい場合

全角文字列の一部を正確に取得したい場合は、mb_substr()を使用します。

mb_substr()とは、マルチバイトの文字列の一部を抜き出す関数となります。

そもそも、マルチバイト文字列とは複数のバイトで成り立っている文字列のことであり、主に全角文字からなる文字列のことを指します。

つまり、mb_substr()を使用することで、ひらがなやカタカナ、漢字などの文字列の一部を正確に取得することができます。

また、全角と半角の文字が混ざった文字列でも正確に取得することができます。

⚫︎ index.php

⚫︎ 実行結果

mb_substr()によって全角と半角の文字が混ざった文字列が変換されています。

そのため、「文章を切り取る!Cut out this text!」では「切り取る!Cut out」が表示されています。

また、「123456789」では「345」が表示されています。

まとめ

⚫︎ substr()とは、文字列の一部を切り出す関数である

⚫︎ substr()を使用するには合計で3つのパラメータを指定できる
・ 対象の文字列(必須)
・ 抜き出す文字の位置(必須)
・ 抜き出す文字の長さ(任意)

⚫︎ substr()のパラメータである「抜き出す文字の位置」に正の数を指定すると、文頭を先頭にして数えた位置までの文字列を取得する

⚫︎ substr()のパラメータである「抜き出す文字の位置」に負の数を指定すると、後ろから数えた位置を先頭にして文末までの文字列を取得する

⚫︎ substr()は全角の文字列に使用すると、抜き出すことはできるが、抜き出す位置によっては文字化けになる
(全角文字列には不向き)

⚫︎ substr()のパラメータである「抜き出す文字の長さ」に正の整数を指定すると、抜き出した文字の文頭から絶対値分の文字を取得する

⚫︎ substr()のパラメータである「抜き出す文字の長さ」に負の整数を指定すると、抜き出した文字列の文末から絶対値分の文字をカットし、抜き出した文字列の文頭からカット前までの文字を取得する

⚫︎ substr()はパラメータとして配列の値を指定することができる
(普通の配列や連想配列でも可能)

⚫︎ 全角文字列の一部を正確に取得したい場合は、mb_substr()を使用する
(全角と半角の文字が混ざった文字列でもOK)

コメントを残す

メールアドレスが公開されることはありません。