概要
get_footer
アクションは、テーマ内の footer.php
を読み込む際に使用されるフックです。このアクションは、主にページのフッターを表示するために用いられ、カスタマイズや追加のスクリプト、スタイル、または情報をフッターに埋め込む際にも利用されます。具体的には、以下のような機能を実装する際によく使われます。
- フッターにカスタムスクリプトを追加する
- フッターにソーシャルメディアリンクを表示する
- フッターにクレジット情報を追加する
- 解析コード(Google Analyticsなど)をフッターに挿入する
- フッターにウィジェットエリアを作成する
- フッターにカスタムメニューを追加する
- フッターに定型文を表示する
- フッターのスタイルを動的に変更する
構文
do_action( 'get_footer', $name );
パラメータ
$name
(string) [オプショナル]: 読み込むフッターファイルの名前。指定しない場合はfooter.php
を読み込む。
戻り値
特になし。
関連する関数
https://refwp.com/?titleonly=1&s=get_footer
使用可能なバージョン
get_footer
アクションは、WordPress 1.5.0 以降で使用可能です。
コアファイルのパス
wp-includes/general-template.php
サンプルコード
サンプルコード 1
add_action( 'get_footer', 'custom_footer_scripts' );
function custom_footer_scripts() {
echo '<script src="https://example.com/script.js"></script>';
}
このサンプルコードは、get_footer
アクションを使用して、フッターに外部スクリプトを追加しています。
サンプルコード 2
add_action( 'get_footer', 'add_social_links' );
function add_social_links() {
echo '<div class="social-links"><a href="#">Facebook</a><a href="#">Twitter</a></div>';
}
このサンプルでは、get_footer
アクションを使って、フッターにソーシャルメディアリンクを追加しています。
サンプルコード 3
add_action( 'get_footer', function() {
echo '<p>© ' . date('Y') . ' My Website. All rights reserved.</p>';
});
このコードは、現在の年を表示するクレジット文をフッターに追加します。
サンプルコード 4
add_action( 'get_footer', 'google_analytics' );
function google_analytics() {
echo "<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-XXXXX-Y', 'auto');
ga('send', 'pageview');
</script>";
}
このサンプルコードは、Google Analytics のトラッキングコードを get_footer
アクションを通してフッターに追加します。
サンプルコード 5
add_action( 'get_footer', 'add_footer_widget' );
function add_footer_widget() {
if ( is_active_sidebar( 'footer-1' ) ) {
dynamic_sidebar( 'footer-1' );
}
}
このコードは、フッターにウィジェットエリアを追加し、そのエリアにアクティブなウィジェットがあれば表示します。
この関数のアクションでの使用可能性
アクション名 | 使用例 |
---|---|
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 | 〇 |
get_footer
アクションは、特定の WordPress バージョンで非推奨または削除されていることはありません。