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

概要

acf_add_options_page関数は、管理メニューにオプションページを追加します。この関数は、特にカスタムオプションを簡単に管理したい場合に有用です。以下のような機能を実装する際によく使われます。

グローバル設定の管理
サイトのコンタクト情報のカスタマイズ
フッターやヘッダーのカスタム設定
ページや投稿のデフォルト設定
特定のテーマやプラグインの設定
APIキーや外部サービスの設定

構文

acf_add_options_page($args);

パラメータ

$args（配列）：オプションページの設定を含む配列。以下のキーが使用可能です。
- ‘page_title’（文字列）: オプションページのタイトル
- ‘menu_title’（文字列）: 管理メニューに表示されるタイトル
- ‘capability’（文字列）: ページの表示に必要なユーザー権限
- ‘menu_slug’（文字列）: ページのスラグ
- ‘position’（整数）: メニュー内の位置
- ‘icon_url’（文字列）: アイコンのURL
- ‘redirect’（真偽値）: ページがキャンセルされた場合のリダイレクト設定

戻り値

ID: オプションページのIDが返されます。

使用可能なバージョン

Advanced Custom Fields: バージョン5.0以上
WordPress: バージョン4.0以上

サンプルコード

サンプルコード1

if( function_exists('acf_add_options_page') ) {
    acf_add_options_page(array(
        'page_title'    => 'サイト設定',
        'menu_title'    => 'サイト設定',
        'menu_slug'     => 'site-settings',
        'capability'    => 'administrator',
        'redirect'      => false
    ));
}

このコードは、サイト全体の設定を管理するオプションページを作成します。

サンプルコード2

if( function_exists('acf_add_options_page') ) {
    acf_add_options_page(array(
        'page_title'    => 'フッター設定',
        'menu_title'    => 'フッター',
        'menu_slug'     => 'footer-options',
        'capability'    => 'edit_posts',
        'icon_url'      => 'dashicons-format-quote',
        'position'      => 3
    ));
}

このコードは、フッターに関する設定を管理するオプションページを追加し、ダッシュアイコンを指定します。

サンプルコード3

if( function_exists('acf_add_options_page') ) {
    acf_add_options_page(array(
        'page_title'    => 'API設定',
        'menu_title'    => 'API設定',
        'menu_slug'     => 'api-settings',
        'capability'    => 'manage_options',
        'redirect'      => false
    ));
}

このコードは、API関連の設定を管理するオプションページを追加します。

サンプルコード4

if( function_exists('acf_add_options_page') ) {
    acf_add_options_page(array(
        'page_title'    => 'ヘッダー情報',
        'menu_title'    => 'ヘッダー',
        'menu_slug'     => 'header-info',
        'capability'    => 'edit_theme_options',
        'icon_url'      => 'dashicons-admin-site',
        'position'      => 5
    ));
}

このコードは、ヘッダーのカスタム情報を設定するページを追加します。

サンプルコード5

if( function_exists('acf_add_options_page') ) {
    acf_add_options_page(array(
        'page_title'    => 'コンタクト情報',
        'menu_title'    => 'コンタクト',
        'menu_slug'     => 'contact-info',
        'capability'    => 'edit_posts',
        'redirect'      => false
    ));
}

このコードは、サイトのコンタクト情報を管理するオプションページを作成します。

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

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

概要

構文