wp_parse_url() の使い方|説明・引数・注意点

説明

wp_parse_url() は、URLを解析し、構成要素(ホスト、パスなど)を取得する関数です。

基本構文

wp_parse_url( string $url, int $component = -1 ): mixed

引数

  • $url:URL
  • $component:取得する要素(PHP_URL_HOST など)

戻り値

要素の配列、または指定した要素の値。

使い方(サンプル)

$host = wp_parse_url( home_url(), PHP_URL_HOST );

注意点

  • PHPの parse_url() のバグを避けた版です。

実務での使いどころ

  • URLを、ホスト名、パス、クエリなどの、部品に分けるとき。
  • URLの、ホスト名だけを、取り出すとき。

よくあるミスと対処

  • $component を指定しない場合、配列のキーが、存在しないことがある。キーの有無を、確認する。
  • scheme のない、URL(//example.com/a など)や、不正なURLで、結果が、変わる。
  • 戻り値が false のときを、考えていない。

NG例

$host = wp_parse_url( $url )['host']; // host がない場合に、エラーになる

OK例

$host = wp_parse_url( $url, PHP_URL_HOST );
if ( $host ) {
	echo esc_html( $host );
}

使い分け早見表

関数 特徴
wp_parse_url() URLを、部品に分ける(WordPress向けの処理つき)
wp_parse_args() 既定値と、渡された値を、まとめる
add_query_arg() URLに、パラメータを追加する

関連項目

add_query_arg()、home_url()、wp_parse_args()

公式リファレンス:wp_parse_url() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました