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

概要

cptui_convert_post_type_posts アクションは、WordPress のプラグイン Custom Post Type UI が提供するフックの一つであり、特にカスタム投稿タイプに関連する機能を実装する際に使用されます。このアクションは、カスタム投稿タイプを作成した後、特定の処理を行うためのポイントとして活用されます。一般的には以下のような機能を実装する際によく使用されます。

カスタム投稿タイプのデフォルトの投稿に対する処理の追加
カスタム投稿タイプに関連するメタデータの追加や修正
特定の条件に基づいたカスタム投稿タイプのデータのフィルタリング
カスタム投稿タイプのデータを処理した後の通知やログの作成
ショートコードとの連携によるカスタム投稿タイプの表示制御
オリジナルのテンプレートを用いたカスタム投稿タイプの表示設定

構文

add_action( 'cptui_convert_post_type_posts', 'your_function_name', 10, 2 );

パラメータ

your_function_name: 実行したい関数の名称
第2引数（オプション）: 投稿のデータに関する情報を持つ配列

戻り値

特に戻り値はありませんが、関数内での処理結果によってはデータベースへの書き込みや出力などが行われます。

対応バージョン

Custom Post Type UI バージョン: 不明（プラグインのバージョンによって異なる場合があります）
WordPress バージョン: 不明（一般的に最新バージョンと互換性があります）

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

アクション名	使用例
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_convert_post_type_posts', 'custom_meta_box_save', 10, 2 );
function custom_meta_box_save( $post_id, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        // メタデータを保存
        update_post_meta( $post_id, '_your_meta_key', 'some_value' );
    }
}

このサンプルコードは、特定のカスタム投稿タイプに対してメタデータを保存する処理を行います。

サンプルコード 2

add_action( 'cptui_convert_post_type_posts', 'filter_custom_post_type', 10, 2 );
function filter_custom_post_type( $post_id, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        // 特定の条件で投稿を変更
        wp_update_post( array( 'ID' => $post_id, 'post_title' => 'Updated Title' ) );
    }
}

このコードは、指定されたカスタム投稿タイプのタイトルを更新する処理を行います。

サンプルコード 3

add_action( 'cptui_convert_post_type_posts', 'log_custom_post_creation', 10, 2 );
function log_custom_post_creation( $post_id, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        error_log( 'Custom Post created with ID: ' . $post_id );
    }
}

このコードは、カスタム投稿タイプが作成された際に、その ID をログに記録します。

サンプルコード 4

add_action( 'cptui_convert_post_type_posts', 'add_shortcode_for_custom_post_type', 10, 2 );
function add_shortcode_for_custom_post_type( $post_id, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        add_shortcode( 'custom_post_shortcode', function() use ( $post_id ) {
            return get_the_title( $post_id );
        });
    }
}

このコードは、カスタム投稿タイプのタイトルを表示するショートコードを追加します。

サンプルコード 5

add_action( 'cptui_convert_post_type_posts', 'custom_redirect_after_conversion', 10, 2 );
function custom_redirect_after_conversion( $post_id, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        wp_redirect( home_url( '/custom-post-success' ) );
        exit;
    }
}

このコードは、特定のカスタム投稿タイプが作成された後に、指定された URL へリダイレクトを行います。

これらのサンプルコードは、cptui_convert_post_type_posts アクションを使用してカスタム投稿タイプに対するさまざまな処理を実装しています。

概要

構文