概要
edit_post_link関数は、特定の投稿やページを編集するためのリンクを生成する際に使用されます。この関数は、WordPressのテンプレートファイル内で通常、ユーザーがその投稿やページを編集するためのインターフェイスを提供します。次のような状況でよく使用されます。
- 投稿リストページでの各投稿の編集リンク表示
- 記事の詳細ページでの執筆者向け編集リンク
- カスタム投稿タイプのクイック編集機能
- コメントリスト内の編集リンク
- 特定の条件に基づくダイナミックな編集リンク
- テーマやプラグイン内でのフロントエンド編集機能
- 限定されたユーザーにのみ表示される編集リンク
- アクセシビリティ向上のための編集リンク出力
構文
edit_post_link( $link, $id, $text, $args );
パラメータ
$link(string): 編集リンクのHTML。省略可能。$id(int): 編集対象の投稿ID。省略可能で、デフォルトは現在の投稿。$text(string): リンクテキスト。省略可能で、デフォルトは「編集」。$args(array): リンクに与える追加のHTML属性。省略可能。
戻り値
- 生成された編集リンクのHTMLを返します。リンクが生成されなかった場合は、
falseを返します。
関連する関数
使用可能なバージョン
- この関数は、WordPress 1.5.0以降で利用可能です。
コアファイルのパス
wp-includes/post.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 |
非推奨又は削除されたバージョン
- 現在のところ、
edit_post_link関数は非推奨または削除されているバージョンはありません。