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

概要

cptui_taxonomy_import_delete_saveアクションは、WordPressのプラグインCustom Post Type UIで使用されるフックの一つです。このアクションは、カスタムタクソノミーのインポート、削除、および保存の際に実行されます。特に、タクソノミーが作成または更新されたときに実行されるので、開発者がカスタムロジックを追加するのに便利です。このアクションは、タクソノミーに関連するデータの管理を行うためによく使われます。

以下は、このアクションがよく使われる場面の例です：
1. タクソノミーを作成または削除した際に関連するデータを整理する。
2. 特定の条件を満たすタクソノミーのデータを自動的にセットアップする。
3. 外部APIと連携してタクソノミーのデータを更新する。
4. タクソノミーが作成或いは削除された際のログを記録する。
5. ユーザー通知のためのカスタムメッセージを生成する。
6. 特定のカスタムメタデータをタクソノミーに紐付ける処理を実行する。

構文

add_action('cptui_taxonomy_import_delete_save', 'your_function_name', 10, 3);

パラメータ

$taxonomy：タクソノミーのスラッグ。
$args：タクソノミーの設定配列。
$action：行われたアクションの種類（’import’、’delete’、’save’のいずれか）。

戻り値

このアクションは何も返しません。主にサイドエフェクト用に使用されます。

互換性

Custom Post Type UIのバージョン：1.10.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_taxonomy_import_delete_save', 'log_taxonomy_action', 10, 3);

function log_taxonomy_action($taxonomy, $args, $action) {
    error_log('Taxonomy ' . $taxonomy . ' was ' . $action);
}

このコードは、タクソノミーがインポート、削除、または保存された際に、その情報をログに記録します。

サンプルコード2

add_action('cptui_taxonomy_import_delete_save', 'set_default_meta_for_taxonomy', 10, 3);

function set_default_meta_for_taxonomy($taxonomy, $args, $action) {
    if ($action === 'save') {
        add_term_meta(0, 'default_meta_key', 'default_value', true);
    }
}

このコードは、タクソノミーが保存されたときに、デフォルトのメタデータをタクソノミーの最初のタームに追加します。

サンプルコード3

add_action('cptui_taxonomy_import_delete_save', 'notify_on_taxonomy_change', 10, 3);

function notify_on_taxonomy_change($taxonomy, $args, $action) {
    if ($action === 'delete') {
        wp_mail('admin@example.com', 'Taxonomy Deleted', "The taxonomy {$taxonomy} was deleted.");
    }
}

このコードは、タクソノミーが削除された際に、管理者に通知メールを送信します。

サンプルコード4

add_action('cptui_taxonomy_import_delete_save', 'sync_taxonomy_with_external_service', 10, 3);

function sync_taxonomy_with_external_service($taxonomy, $args, $action) {
    // 外部APIへの同期処理をここに実装
}

このコードスニペットは、外部サービスとタクソノミーの同期処理のための関数を定義しています。

サンプルコード5

add_action('cptui_taxonomy_import_delete_save', 'custom_actions_on_taxonomy', 10, 3);

function custom_actions_on_taxonomy($taxonomy, $args, $action) {
    if ($action === 'import') {
        // 特定のカスタム処理を実行
    }
}

このコードは、タクソノミーがインポートされた際に特定の処理を実行するための関数を提供します。

概要

構文