概要
get_previous_posts_link
フィルタは、前ページ(アーカイブ)へのリンクテキストを取得するために使用されます。このフィルタを使用することで、デフォルトで表示される「前のページ」というテキストを変更したり、カスタマイズしたりすることができます。また、特定の条件に基づいてテキストを動的に変更することも可能です。
使用例
このフィルタは以下のような機能を実装する際によく使われます。
- ページネーションをカスタマイズする
- SEOに適したリンクテキストを生成する
- 多言語対応のサイトでのテキスト変更
- ユーザーの嗜好に合わせたテキストのカスタマイズ
- スタイルに合わせたテキストの変更
- 特定の条件に基づくリンクテキストの制御
- アクセシビリティの改善
- ブランドメッセージを反映させたテキスト作成
構文
add_filter('get_previous_posts_link', 'your_custom_function');
パラメータ
- $link: 変更されたリンクテキスト
- $class: クラス名(オプション)
戻り値
カスタマイズされたリンクテキストを返します。
関連する関数
https://refwp.com/?titleonly=1&s=get_previous_posts_link
バージョン
このフィルタはWordPress 2.3.0から使用可能です。
コアファイルのパス
wp-includes/link-template.php
サンプルコード
サンプル1: デフォルトテキストをカスタマイズする
add_filter('get_previous_posts_link', function($link) {
return str_replace('« Previous', '前のページ', $link);
});
このサンプルコードは、デフォルトの「前のページ」のテキストを「前のページ」というカスタムテキストに変更します。
サンプル2: 条件に応じてテキストを変更する
add_filter('get_previous_posts_link', function($link) {
if (is_category()) {
return '古い記事';
}
return $link;
});
このコードは、カテゴリーページで表示される「前のページ」リンクのテキストを「古い記事」に変更します。
サンプル3: HTMLを追加する
add_filter('get_previous_posts_link', function($link) {
return '<strong>' . $link . '</strong>';
});
このサンプルでは、リンクテキストを強調表示するためにタグを追加しています。
サンプル4: 多言語対応のテキストにする
add_filter('get_previous_posts_link', function($link) {
return __('前のページ', 'text-domain');
});
このコードは、WordPressの翻訳機能を利用して、リンクテキストを多言語対応にします。‘text-domain’を適切なテキストドメインに変更する必要があります。
サンプル5: クラスを追加する
add_filter('get_previous_posts_link', function($link) {
return str_replace('<a', '<a class="custom-class"', $link);
});
このサンプルは、前ページ(アーカイブ)へのリンクに「custom-class」というクラスを追加します。
この関数のアクションでの使用可能性
アクション名 | 使用可能性 |
---|---|
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_previous_posts_link
フィルタは、特定のバージョンで非推奨または削除されていないため、そのような情報はありません。