• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/add options page

提供: WordPress Codex 日本語版
移動先: 案内検索

説明

設定メニューにサブメニューページを追加する。

使い方

 <?php
     add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function);
 ?>

パラメータ

$page_title
文字列) (必須) メニューが選択したページのタイトルタグに表示されるテキスト
初期値: なし
$menu_title
文字列) (必須) メニューに使用されるテキスト
初期値: なし
$capability
文字列) (必須) The capability required for this menu to be displayed to the user.
初期値: なし
$menu_slug
文字列) (必須) スラッグ名 to refer to this menu by (should be unique for this menu).
初期値: なし
$function
コールバック) (オプション) The function to be called to output the content for this page.
初期値: ' '

戻り値

文字列 
The resulting page's hook_suffix (What add_submenu_page() returns)

  • This function is a simple wrapper for a call to add_submenu_page(), passing the received arguments and specifying 'options-general.php' as the $parent_slug argument. This means the new options page will be added as a sub menu to the Settings menu.
  • The $capability parameter is used to determine whether or not the page is included in the menu based on the ユーザーの種類と権限) of the current user.
  • The function handling the output of the options page should also verify the user's capabilities.
  • If there are spaces in the slug, then these will be stripped out when the URL is generated. This will result in an error message telling you that you do not have sufficient permissions to view the page.

用例

Typical usage occurs in a function registered with the 'admin_menu' フック (管理メニューの追加を参照。):

add_action('admin_menu', 'my_plugin_menu');

function my_plugin_menu() {
	add_options_page('My Options', 'My Plugin', 'manage_options', 'my-plugin.php', 'my_plugin_page');
}


Object Oriented options page helper / view:

class options_page {
	function __construct() {
		add_action( 'admin_menu', array( $this, 'admin_menu' ) );
	}
	function admin_menu () {
		add_options_page( 'Page Title','Circle Tree Login','manage_options','options_page_slug', array( $this, 'settings_page' ) );
	}
	function  settings_page () {
		echo 'This is the page content';
	}
}
new options_page;

ソースファイル

add_options_page()wp-admin/includes/plugin.phpにあります。

関連

管理メニュー: add_menu_page(), remove_menu_page(), add_submenu_page() /en, remove_submenu_page() /en, add_dashboard_page() /en, add_posts_page() /en, add_media_page() /en, add_links_page() /en, add_pages_page() /en, add_comments_page() /en, add_theme_page() /en, add_plugins_page() /en, add_users_page() /en, add_management_page() /en, add_options_page()


このページ「関数リファレンス/add options page」は一部未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/add_options_page最新版との差分