概要
wp_untrash_post アクションは、投稿情報をゴミ箱から取り出す際に発生します。このアクションは、投稿が復元されたときに特定の処理を実行するために使用されます。開発者はこのアクションを利用して、復元された投稿に関連するカスタム機能やプロセスをトリガーすることができます。具体的には、以下のような機能を実装する際によく使われます。
- 復元された投稿へのカスタムメタデータの処理
- 投稿がゴミ箱から復元されたことを記録するログの作成
- ソーシャルメディアへの通知
- 復元後の特定のコンテンツ設定を適用
- ユーザーへの通知メール送信
- 復元時に特定のサイドバーを表示
- 投稿復元時の特定のカスタムアクションの実行
- SEOプラグインとの連携処理
構文
do_action('wp_untrash_post', $post_id);
パラメータ
$post_id(int): 復元された投稿のID。
戻り値
このアクションは特定の戻り値を持ちません。
関連する関数
このアクションに関連する関数は次のリンクから確認できます: wp_untrash_post
使用可能なバージョン
wp_untrash_post アクションは、WordPress 3.6以降で利用可能です。
コアファイルのパス
このアクションは、以下のコアファイルに含まれています。
– wp-includes/post.php
サンプルコード
サンプルコード1: 投稿が復元されたことを通知する
add_action('wp_untrash_post', 'notify_post_restoration');
function notify_post_restoration($post_id) {
$post_title = get_the_title($post_id);
$message = "投稿『{$post_title}』が復元されました。";
error_log($message); // ブラウザのエラーログに通知を記録
}
このサンプルコードは、投稿が復元されたときにそのタイトルをエラーログに記録します。
サンプルコード2: メタデータを更新する
add_action('wp_untrash_post', 'update_meta_on_restoration');
function update_meta_on_restoration($post_id) {
update_post_meta($post_id, 'restored_date', current_time('mysql'));
}
この例では、復元された投稿に対して、復元日をメタデータとして追加しています。
サンプルコード3: 復元後に特定のタクソノミーを適用する
add_action('wp_untrash_post', 'apply_taxonomy_on_restoration');
function apply_taxonomy_on_restoration($post_id) {
wp_set_post_terms($post_id, '復元済み', 'status');
}
このサンプルでは、復元された投稿に「復元済み」というタクソノミーを適用しています。
サンプルコード4: ユーザーにメール通知を送信する
add_action('wp_untrash_post', 'send_email_on_restoration');
function send_email_on_restoration($post_id) {
$author_email = get_the_author_meta('user_email', get_post_field('post_author', $post_id));
wp_mail($author_email, '投稿が復元されました', 'あなたの投稿が復元されました。');
}
このコードは、復元された投稿の著者にメール通知を送信します。
サンプルコード5: ソーシャルメディアに投稿を通知する
add_action('wp_untrash_post', 'notify_social_media');
function notify_social_media($post_id) {
$post_url = get_permalink($post_id);
// ソーシャルメディアAPIを使って投稿を通知する処理を追加
}
この例では、復元された投稿のURLを取得し、ソーシャルメディアに投稿を通知する処理のきっかけを作ります。
この関数のアクションでの使用可能性
| アクション名 | 使用可能性 |
|---|---|
| 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 |
非推奨または削除されたバージョン
特に非推奨または削除されたバージョンはありません。 wp_untrash_post は現在も有効なアクションとして使用されています。