プラグインAdvanced custom fields(ACF)のacf_set_options_page_menu関数の使用方法・解説

概要

acf_set_options_page_menu 関数は、Advanced Custom Fields (ACF) プラグインにおいて、デフォルトのオプションページのメニュー名を設定するために使用されます。この関数を利用することで、サイト管理者はオプションページの名称をカスタマイズし、より直感的な名前にすることができます。特に、カスタムオプションページを追加する際や、特定の設定を管理するために利用されることが一般的です。

この関数は以下のような機能を実装する際によく使われます。
1. オプションページの名前を変更したいとき
2. カスタム設定ページを追加する際にメニューのラベルを調整する場合
3. 複数のオプションページを持つ際に明確に区別したいとき
4. サイトのブランド名に合った名称に変更したい場合
5. ユーザー向けのカスタマイズされた管理インターフェースを提供したいとき
6. 他のプラグインや機能との競合を避けるために命名を工夫したい場合

構文

acf_set_options_page_menu( $menu_title );

パラメータ

$menu_title (string) – 新しく設定するオプションページのメニュー名。

戻り値

なし

バージョン情報

ACF バージョン: 5.0.0 以降
WordPress バージョン: 4.4 以降

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

アクション	使用可能
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('acf/init', 'my_acf_option_page');
function my_acf_option_page() {
    acf_add_options_page();
    acf_set_options_page_menu('サイト設定');
}

このサンプルは、ACFのオプションページを追加し、そのメニュー名を「サイト設定」に変更しています。

サンプルコード2

add_action('acf/options_page_updated', 'my_menu_title_change');
function my_menu_title_change() {
    acf_set_options_page_menu('カスタムオプション');
}

このコードは、オプションページが更新されたときに、そのメニュー名を「カスタムオプション」に変更します。

サンプルコード3

if( function_exists('acf_set_options_page_menu') ) {
    acf_set_options_page_menu('全体設定');
}

このサンプルは、関数が存在する場合にオプションページのメニュー名を「全体設定」に設定します。

サンプルコード4

add_action('plugin_loaded', function() {
    acf_set_options_page_menu('一般設定');
});

このコードは、プラグインがロードされたときに「一般設定」というメニュー名でオプションページを設定します。

サンプルコード5

add_action('admin_menu', function() {
    acf_set_options_page_menu('サイトオプション');
});

このサンプルは、WordPressの管理メニューが読み込まれた際にオプションページのメニュー名を「サイトオプション」に設定します。

概要

構文