ダッシュボードに新たなカスタムメタボックスを追加

はじめに

この記事では、WordPressの管理画面（ダッシュボード）に、新たなカスタムメタボックスを追加するための「サンプルコード」・「記述内容の説明」を掲載します。

この記事でのキーワード
Word Press関数, Word Press, カスタムメタボックス

サンプルコード

function add_custom_meta_box_for_products() {
  add_meta_box(
    'custom_product_info', // ﾒﾀﾎﾞｯｸｽのID
            __('商品情報', 'textdomain'),
            'custom_product_info_meta_box_callback',
            'products',
            'normal', 
            'high'
  );
}
add_action('add_meta_boxes','add_custom_meta_box_for_products');

記述内容の説明

• function add_custom_meta_box_for_products() {}
  →まず新たな関数を定義します。この関数内でメタボックスの設定を行います。
• add_meta_box()
  →メタボックスを追加するためのWordPress関数です。
  
• 'custom_product_info'
  →メタボックスのIDを指定します。これは他のメタボックスと区別するための一意の識別子となります。
• __('商品情報', 'textdomain')
  →メタボックスのタイトルを指定します。「商品情報」がそのタイトルとなります。
• 'custom_product_info_meta_box_callback'
  →メタボックス内に表示する内容を定義するためのコールバック関数を指定します。ここで名前だけ指定し、具体的な内容は別途この関数を定義することになります。
• 'products'
  →このメタボックスが表示される投稿タイプを指定します。ここではカスタム投稿タイプ「products」を指定しています。
• 'normal'
  →メタボックスの表示位置を指定します。「normal」は投稿のメインコンテンツ下部に表示します。
• 'high'
  →メタボックスの優先順位を指定します。「high」とすれば、他のメタボックスよりも前にこのメタボックスを表示します。
• add_action('add_meta_boxes','add_custom_meta_box_for_products')
  →add_meta_boxesアクションフックに対して、作成したadd_custom_meta_box_for_products関数を追加します。これにより、投稿画面が開いた時に「商品情報」のメタボックスが追加されます。このコードではコールバック関数 'custom_product_info_meta_box_callback' が指定されていますが、その定義がコード上にないため、この関数を自分で作り、その中でメタボックスの中身（例えば、フォーム入力など）を定義する必要があります。