概要
previous_image_linkフィルタは、前の添付ファイルへのリンクを表示するために使用されます。このフィルタは、WordPressのメディアギャラリーや投稿内で、前の画像へのリンクをカスタマイズする際に便利です。このフィルタを使用することで、リンクを独自のスタイルに変更したり、HTML属性を追加したりできます。
このフィルタは、以下のような機能を実装する際によく使われます：
1. メディアギャラリーのカスタマイズ
2. 画像リンクのスタイル変更
3. HTML属性の追加
4. 特定の条件に基づくリンクの表示制御
5. ショートコード内での画像リンクの変更
6. 関連画像へのリンク作成
7. テーマのカスタマイズ
8. ページ遷移の体験向上
構文
apply_filters('previous_image_link', $html, $id);
パラメータ
$html(string): 最初の生成されるHTMLリンク$id(int): 添付ファイルのID
戻り値
- $html: フィルタを適用した後のHTMLリンク
関連する関数
使用可能なバージョン
WordPress 2.5以降で利用可能です。
コアファイルのパス
wp-includes/media.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: HTML属性を追加する
add_filter('previous_image_link', 'custom_previous_image_link', 10, 2);
function custom_previous_image_link($html, $id) {
return str_replace('<a ', '<a class="my-custom-class" ', $html);
}
説明: 前の画像リンクにカスタムクラスを追加します。
サンプル2: リンクを新しいタブで開く
add_filter('previous_image_link', 'open_previous_image_in_new_tab', 10, 2);
function open_previous_image_in_new_tab($html, $id) {
return str_replace('<a ', '<a target="_blank" ', $html);
}
説明: 前の画像リンクを新しいタブで開くようにします。
サンプル3: リンクの内容をカスタマイズ
add_filter('previous_image_link', 'customize_link_text', 10, 2);
function customize_link_text($html, $id) {
return '<a href="' . get_permalink($id) . '">前の画像へ</a>';
}
説明: 前の画像へのリンクを「前の画像へ」というテキストにカスタマイズします。
サンプル4: 条件に基づくリンクの非表示
add_filter('previous_image_link', 'conditionally_hide_previous_image_link', 10, 2);
function conditionally_hide_previous_image_link($html, $id) {
if (is_single() && get_post_type() === 'post') {
return ''; // 投稿タイプが通常の投稿の場合、リンクを非表示
}
return $html;
}
説明: 特定の条件下で前の画像リンクを非表示にします。
サンプル5: リンクの前にアイコンを追加
add_filter('previous_image_link', 'add_icon_to_previous_image_link', 10, 2);
function add_icon_to_previous_image_link($html, $id) {
return '<span class="icon-prev"></span>' . $html;
}
説明: 前の画像リンクの前にアイコンを追加します。