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

概要

cptui_filtered_post_type_post_global_strings フィルタは、WordPressのCustom Post Type UIプラグイン内で使用されるフィルタの一つで、カスタム投稿タイプを定義する際の文字列をフィルタリングするために使用されます。このフィルタを使うことで、特定のテキストを変更したり、新しいテキストを追加したりすることができます。以下のような機能を実装する際によく使われます。

カスタム投稿タイプのラベルの変更
メニューのタイトルのカスタマイズ
管理画面の表示文字列の翻訳
カスタム投稿タイプの説明文の変更
管理者向けのヘルプテキストの追加
ショートコードで表示するテキストの調整

構文

add_filter('cptui_filtered_post_type_post_global_strings', 'your_function_name');

パラメータ

global_strings (配列): フィルタリングされる文字列の配列。

戻り値

フィルタリングされた文字列の配列。

バージョン

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_filter('cptui_filtered_post_type_post_global_strings', 'change_custom_post_type_label');

function change_custom_post_type_label($global_strings) {
    $global_strings['post_type_label'] = '新しいラベル';
    return $global_strings;
}

このサンプルは、カスタム投稿タイプのラベルを「新しいラベル」に変更します。

サンプルコード2

add_filter('cptui_filtered_post_type_post_global_strings', 'custom_dashboard_text');

function custom_dashboard_text($global_strings) {
    $global_strings['dashboard_text'] = 'カスタム投稿タイプダッシュボードテキスト';
    return $global_strings;
}

このサンプルは、カスタム投稿タイプのダッシュボードに表示されるテキストをカスタマイズします。

サンプルコード3

add_filter('cptui_filtered_post_type_post_global_strings', 'add_custom_help_text');

function add_custom_help_text($global_strings) {
    $global_strings['help_text'] = 'このカスタム投稿タイプのヘルプテキストです。';
    return $global_strings;
}

このサンプルは、カスタム投稿タイプのヘルプテキストを追加します。

サンプルコード4

add_filter('cptui_filtered_post_type_post_global_strings', 'modify_menu_title');

function modify_menu_title($global_strings) {
    $global_strings['menu_name'] = 'カスタムメニュー名';
    return $global_strings;
}

このサンプルは、カスタム投稿タイプのメニュー名を変更します。

サンプルコード5

add_filter('cptui_filtered_post_type_post_global_strings', 'custom_post_type_description');

function custom_post_type_description($global_strings) {
    $global_strings['post_type_description'] = 'これはカスタム投稿タイプの説明文です。';
    return $global_strings;
}

このサンプルは、カスタム投稿タイプの説明文を設定します。

概要

構文