プラグインCustom Post Type UIのcptui_post_type_deletedアクションの使用方法・解説

概要

cptui_post_type_deleted アクションは、Custom Post Type UI プラグインにおいて、カスタム投稿タイプが削除された際に実行されるフックです。このアクションを使用することで、カスタム投稿タイプが削除された後に特定の処理を実行することが可能になります。例えば、関連するデータの削除や通知の送信などが考えられます。

このアクションを使用する際によく行われる処理には、以下のものがあります：

削除された投稿タイプに関連するメタデータのクリーニング
特定のユーザーにメール通知を送信する
削除ログの記録
フロントエンドのキャッシュをクリア
アナリティクスのデータを更新
他のシステムとの連携処理

構文

do_action('cptui_post_type_deleted', $post_type);

パラメータ

$post_type (string): 削除されたカスタム投稿タイプのスラッグ。

戻り値

このアクションは戻り値を持たず、実行される処理はフックで登録されたコールバック関数によって決まります。

使用可能なプラグインおよびワードプレスのバージョン

Custom Post Type UI バージョン: 1.0.0以降
WordPress バージョン: 4.0以降

この関数のアクションでの使用可能性

アクション	使用例
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

add_action('cptui_post_type_deleted', 'my_custom_post_type_deleted', 10, 1);

function my_custom_post_type_deleted($post_type) {
    // 削除されたカスタム投稿タイプに関連するメタデータを削除
    delete_post_meta_by_key('custom_meta_key', $post_type);
}

このコードは、削除されたカスタム投稿タイプに関連するメタデータ（特定のキー）の削除を行っています。

サンプルコード2

add_action('cptui_post_type_deleted', 'notify_admin_on_post_type_deleted', 10, 1);

function notify_admin_on_post_type_deleted($post_type) {
    // 管理者に削除を通知するメールを送信
    $admin_email = get_option('admin_email');
    wp_mail($admin_email, 'カスタム投稿タイプが削除されました', "投稿タイプ '{$post_type}' が削除されました。");
}

このコードは、カスタム投稿タイプが削除された際に管理者に通知メールを送信します。

サンプルコード3

add_action('cptui_post_type_deleted', 'log_post_type_deletion', 10, 1);

function log_post_type_deletion($post_type) {
    // 削除された投稿タイプに関するログをファイルに記録
    $log_entry = date("Y-m-d H:i:s") . " - '$post_type' 投稿タイプが削除されました。n";
    file_put_contents('deletion_log.txt', $log_entry, FILE_APPEND);
}

このコードは、削除されたカスタム投稿タイプの情報をdeletion_log.txtというファイルに記録します。

サンプルコード4

add_action('cptui_post_type_deleted', 'clear_cache_on_post_type_deleted', 10, 1);

function clear_cache_on_post_type_deleted($post_type) {
    // 特定のキャッシュをクリアする処理
    if(function_exists('clear_site_cache')) {
        clear_site_cache();
    }
}

このコードは、カスタム投稿タイプが削除された際にサイトのキャッシュをクリアする関数を呼び出します。

サンプルコード5

add_action('cptui_post_type_deleted', 'update_analytics_on_post_type_deleted', 10, 1);

function update_analytics_on_post_type_deleted($post_type) {
    // アナリティクスに削除を通知するリクエストを送信
    $api_url = 'https://analytics.example.com/track-deletion';
    wp_remote_post($api_url, array(
        'body' => json_encode(array('post_type' => $post_type)),
        'headers' => array('Content-Type' => 'application/json')
    ));
}

このコードは、アナリティクスサービスにカスタム投稿タイプの削除を通知するリクエストを送信します。

概要

構文