ワードプレスのuntrailingslashit関数の使用方法・解説

概要

untrailingslashit 関数は、URLやファイルパスの末尾からスラッシュを取り除くために使用される WordPress の関数です。これにより、URL の一貫性を保ち、無駄なスラッシュの混在を防ぐことができます。この関数は、特に以下のような機能を実装する際に便利です：

1. リダイレクト処理
2. URL 構築
3. パーマリンクの設定
4. データベースクエリの生成
5. ルーティング処理
6. テンプレートファイルの指定
7. API エンドポイントの処理
8. エラーハンドリング

構文

untrailingslashit( string $string )

パラメータ

• $string (string): スラッシュを取り除きたい文字列。

戻り値

• (string): 末尾のスラッシュが削除された文字列。

関連する関数

• trailingslashit
• rtrim

使用可能なバージョン

untrailingslashit 関数は WordPress 1.5.0 以降で使用可能です。

コアファイルのパス

untrailingslashit 関数は、wp-includes/functions.php に含まれています。

この関数のアクションでの使用可能性

アクション	使用例
mu_plugin_loaded
registered_post_type
plugins_loaded	〇
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init	〇
register_sidebar
wp_loaded	〇
send_headers
parse_query
pre_get_posts
wp	〇
template_redirect
get_header
wp_head

サンプルコード

サンプルコード 1

$url = "http://example.com/";
$clean_url = untrailingslashit($url);
echo $clean_url; // 出力: http://example.com

説明: URL の末尾からスラッシュを取り除いて、クリーンなURLを出力しています。

サンプルコード 2

$path = "/var/www/html/project/";
$clean_path = untrailingslashit($path);
echo $clean_path; // 出力: /var/www/html/project

説明: ファイルシステムのパスから末尾のスラッシュを削除し、安定したパスを出力します。

サンプルコード 3

$base_url = "http://example.com/api/";
$endpoint = "v1/resource/";
$full_url = untrailingslashit($base_url) . '/' . untrailingslashit($endpoint);
echo $full_url; // 出力: http://example.com/api/v1/resource

説明: API のエンドポイントを生成する際に、URL のスラッシュを適切に処理しています。

サンプルコード 4

$user_input = "http://example.com/some/path/";
$safe_url = untrailingslashit($user_input);
if ($safe_url === "http://example.com/some/path") {
    echo "URL is sanitized.";
}

説明: ユーザーからの入力されたURLをクリーンにし、条件に基づいて処理を続けます。

サンプルコード 5

$file_path = "/uploads/files/";
$final_path = untrailingslashit($file_path);
$final_path .= "/image.jpg"; 
echo $final_path; // 出力: /uploads/files/image.jpg

説明: ファイルパスに対して末尾のスラッシュを削除し、さらにファイル名を追加しています。