概要
cptui_main_page_before_changelog
アクションは、Custom Post Type UIプラグインのメインページの変更ログが表示される前に実行されます。このフックは、特にプラグインの設定やカスタマイズを行う際に役立ちます。以下のようなシナリオでよく使用されます。
- プラグインの設定をカスタマイズする。
- ユーザー通知メッセージを表示する。
- プラグインのバージョン情報を表示する。
- デバッグ情報を追加する。
- ユーザーに向けたカスタムヘルプやチュートリアルのリンクを提供する。
- UIのスタイリングやJavaScriptの読み込みなど。
構文
add_action('cptui_main_page_before_changelog', 'your_function_name');
パラメータ
このアクションにはパラメータが渡されません。
戻り値
このアクションは何も戻しません。
バージョン
- Custom Post Type UIバージョン: 1.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_main_page_before_changelog', 'custom_cptui_notification');
function custom_cptui_notification() {
echo '<div class="notice notice-info"><p>Custom Post Type UIの設定を変更しましたか?新機能をお見逃しなく!</p></div>';
}
説明: メインページにカスタムメッセージを表示します。
サンプル2: スタイルの追加
add_action('cptui_main_page_before_changelog', 'add_custom_styles');
function add_custom_styles() {
echo '<style>
.custom-notice { background: #f0f8ff; padding: 10px; }
</style>';
}
説明: メインページにカスタムスタイルを追加し、他の要素のデザインを強調します。
サンプル3: デバッグ情報の表示
add_action('cptui_main_page_before_changelog', 'debug_info_display');
function debug_info_display() {
echo '<pre>' . print_r($GLOBALS['cptui_options'], true) . '</pre>';
}
説明: グローバル変数を用いて、CPT UIの設定情報をデバッグ用に表示します。
サンプル4: チュートリアルリンクの追加
add_action('cptui_main_page_before_changelog', 'add_tutorial_link');
function add_tutorial_link() {
echo '<p><a href="https://example.com/tutorial" target="_blank">CPT UIのチュートリアルはこちら</a></p>';
}
説明: 外部のチュートリアルリンクを提供して、ユーザーが学習できるようにします。
サンプル5: プラグインバージョン情報の表示
add_action('cptui_main_page_before_changelog', 'display_plugin_version');
function display_plugin_version() {
echo '<p>現在のプラグインバージョン: ' . CTPUI_VERSION . '</p>';
}
説明: プラグインの現在のバージョンをダイナミックに表示します。
このように、cptui_main_page_before_changelog
アクションを使って、さまざまなカスタマイズや情報表示が可能になります。