ワードプレスのincludes_urlフィルタの使用方法・解説

概要

includes_url フィルタは、wp-includesディレクトリ以下のURLを取得する際に使用されるフィルタです。このフィルタは、以下のような機能を実装する際によく使われます：

1. スクリプトやスタイルシートのパスをカスタマイズする。
2. プラグインやテーマで独自のリソースに向けたURLを設定する。
3. 本番環境と開発環境で異なるURLを返す。
4. マルチサイト環境でネットワーク全体のURLを調整する。
5. アセット管理用のCDNのURLを適用する。
6. 特定の条件に基づいてURLを変更する。
7. サードパーティライブラリへの参照を調整する。
8. 解析ツールやトラッキングコードを追加する。

構文

add_filter('includes_url', 'custom_includes_url');

パラメータ

• $url (string) – wp-includesディレクトリのURL。

戻り値

• (string) – 変更されたURL。

関連する関数

https://refwp.com/?titleonly=1&s=includes_url

使用可能なバージョン

includes_url フィルタは、WordPressのバージョン1.5以降で利用可能です。

コアファイルパス

• wp-includes/general-template.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の設定

add_filter('includes_url', function($url) {
    return str_replace('wp-includes', 'custom-includes', $url);
});

このサンプルコードは、wp-includesディレクトリのURLを “custom-includes” に変更します。

1. 特定条件でのURL変更

add_filter('includes_url', function($url) {
    if (is_home()) {
        return str_replace('wp-includes', 'home-includes', $url);
    }
    return $url;
});

このサンプルコードは、ホームページが表示されているときに、wp-includesディレクトリのURLを “home-includes” に変更します。

1. CDN用のURLに変更

add_filter('includes_url', function($url) {
    return 'https://cdn.example.com/' . basename($url);
});

このサンプルコードは、すべてのwp-includesディレクトリのURLを指定されたCDNにポイントします。

1. 開発環境でのURL変更

add_filter('includes_url', function($url) {
    if (defined('WP_ENV') && WP_ENV === 'development') {
        return str_replace('wp-includes', 'dev-includes', $url);
    }
    return $url;
});

このサンプルコードは、開発環境の設定が行われている場合にwp-includesのURLを “dev-includes” に変更します。

1. URLにトラッキングパラメータを追加

add_filter('includes_url', function($url) {
    return $url . '?utm_source=wordpress';
});

このサンプルコードは、すべてのwp-includesディレクトリのURLにトラッキング用のクエリパラメータを追加します。

これらのコードはそれぞれ異なる用途に設定変更を行うものであり、WordPressサイトにおけるURLの動作を柔軟に調整することができます。