プラグインCustom Post Type UIのcptui_inside_post_type_wrapフィルタの使用方法・解説

概要

cptui_inside_post_type_wrap フィルタは、プラグイン Custom Post Type UI において、カスタム投稿タイプの設定画面の特定の位置で処理を拡張する際に利用されます。このフィルタを使うことで、管理画面に追加の情報や設定を挿入することが可能になります。以下は、このフィルタがよく使われる場面の例です。

1. 特定のカスタムフィールドの説明を追加する。
2. カスタム投稿タイプに関連するデフォルトの設定を調整する。
3. ユーザー向けのカスタムメッセージを提供する。
4. カスタムメタボックスを追加する。
5. 特定の条件に基づいて設定の選択肢を変更する。
6. プラグインのドキュメントへのリンクを追加する。

フィルタの概要

• 構文: add_filter( 'cptui_inside_post_type_wrap', 'your_function_name', 10, 2 );

• パラメータ:

  • $content (string) – デフォルトのコンテンツ。
  • $post_type (string) – 現在のカスタム投稿タイプのスラッグ。

• 戻り値: 修正されたコンテンツの文字列。

利用可能なバージョン

• Custom Post Type UI バージョン: 最新バージョンの使用を推奨
• WordPress バージョン: WordPress 5.0 以上

サンプルコード

サンプルコード 1: 説明文を追加する

このコードは、カスタム投稿タイプの設定画面に説明文を追加します。

add_filter( 'cptui_inside_post_type_wrap', function( $content, $post_type ) {
    if ( $post_type === 'your_custom_post_type' ) {
        $content .= '<p>このカスタム投稿タイプには特別なフィールドがあります。</p>';
    }
    return $content;
});

引用元: https://github.com/CPTUI/CPT-UI

サンプルコード 2: デフォルト設定を変更する

カスタム投稿タイプのデフォルトの設定を変更します。

add_filter( 'cptui_inside_post_type_wrap', function( $content, $post_type ) {
    if ( $post_type === 'your_custom_post_type' ) {
        $content .= '<input type="checkbox" id="custom_option" name="custom_option" value="1"> 特殊オプションを有効にする';
    }
    return $content;
});

引用元: https://github.com/CPTUI/CPT-UI

サンプルコード 3: ユーザー向けのメッセージを表示する

特定のメッセージを表示することができます。

add_filter( 'cptui_inside_post_type_wrap', function( $content, $post_type ) {
    if ( $post_type === 'your_custom_post_type' ) {
        $content .= '<div class="notice notice-info">注意: この投稿タイプは特別な機能があります。</div>';
    }
    return $content;
});

引用元: https://github.com/CPTUI/CPT-UI

サンプルコード 4: メタボックスを追加する

このコードはカスタムメタボックスを追加します。

add_filter( 'cptui_inside_post_type_wrap', function( $content, $post_type ) {
    if ( $post_type === 'your_custom_post_type' ) {
        $content .= '<div class="metabox">ここにメタボックスの内容</div>';
    }
    return $content;
});

引用元: https://github.com/CPTUI/CPT-UI

サンプルコード 5: ウェブサイトへのリンクを追加する

ドキュメントへのリンクを追加します。

add_filter( 'cptui_inside_post_type_wrap', function( $content, $post_type ) {
    if ( $post_type === 'your_custom_post_type' ) {
        $content .= '<p><a href="https://example.com/docs">ここをクリックして詳細を見る</a></p>';
    }
    return $content;
});

引用元: https://github.com/CPTUI/CPT-UI

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

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