概要
next_image_linkフィルタは、次の添付ファイルへのリンクを表示するために使用されます。このフィルタを利用すると、画像のギャラリーや添付ファイルのナビゲーションをカスタマイズすることができ、次の画像へのリンクHTMLを変更できます。具体的には、以下のような場面でよく使用されます。
- 画像のリンクのスタイルを変更したい場合
- 画像の遷移をスムーズにする場合
- 特定のクラスやIDを追加したい場合
- 生のHTMLコードを動的に評価したい場合
- リンクにカスタムデータ属性を追加したい場合
- 前後にサムネイルや情報を表示したい場合
- 特定の条件に基づいてリンクを非表示にしたい場合
- SEO目的でのリンクテキストを変更したい場合
構文
add_filter('next_image_link', 'my_custom_next_image_link', 10, 3);
パラメータ
$html(string): 次の画像へのリンクが含まれるHTML。$id(int): 現在の画像のID。$attachment(WP_Post): 現在の画像の添付ファイルオブジェクト。
戻り値
- (string): 修正された次の画像へのリンクが含まれるHTML。
関連する関数
使用可能なバージョン
next_image_linkフィルタは、WordPress 1.2以降で使用可能です。
コアファイルのパス
wp-includes/media.php
サンプルコード
サンプルコード1: リンクのスタイルを変更する
add_filter('next_image_link', 'custom_next_image_link_style', 10, 3);
function custom_next_image_link_style($html, $id, $attachment) {
return str_replace('class="next"', 'class="my-custom-class"', $html);
}
このサンプルコードは、次の画像へのリンクのクラスをmy-custom-classに変更します。
サンプルコード2: データ属性を追加
add_filter('next_image_link', 'add_data_attribute_to_next_image_link', 10, 3);
function add_data_attribute_to_next_image_link($html, $id, $attachment) {
return str_replace('<a ', '<a data-custom="value" ', $html);
}
このフィルタを使用すると、次の画像へのリンクにカスタムデータ属性data-customが追加されます。
サンプルコード3: SEO向けにリンクテキストを変更する
add_filter('next_image_link', 'change_next_image_link_text', 10, 3);
function change_next_image_link_text($html, $id, $attachment) {
return str_replace('next', '次の画像', $html);
}
このサンプルコードは、次の画像へのリンクのテキストを「次の画像」に変更します。
サンプルコード4: リンクを非表示にする条件を追加
add_filter('next_image_link', 'conditional_next_image_link', 10, 3);
function conditional_next_image_link($html, $id, $attachment) {
if (some_condition()) {
return ''; // リンクを非表示
}
return $html;
}
指定した条件（some_condition()）が真の場合に、次の画像へのリンクを非表示にします。
サンプルコード5: リンクにサムネイルを追加する
add_filter('next_image_link', 'add_thumbnail_to_next_image_link', 10, 3);
function add_thumbnail_to_next_image_link($html, $id, $attachment) {
$thumbnail = wp_get_attachment_image(get_next_attachment_id($id), 'thumbnail');
return $html . $thumbnail; // リンクの後にサムネイルを追加
}
このフィルタは、次の画像へのリンクにサムネイルを追加します。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 |
非推奨または削除されたバージョン
特にこのフィルタが非推奨または削除されたバージョンはありません。