当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「Adding Contextual Help to Administration Menus」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
({{原文|Adding Contextual Help to Administration Menus|91876}}<!-- 21:27, 7 August 2010 Lorelle 版 -->)
 
(翻訳済み。ページ名検討中)
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
== Introduction ==
+
== はじめに ==
Ever since WordPress [[Version 3.0]], every built-in [[Administration Panels#Help|Administration Panel]] has contained a contextual help section providing additional information to the user on how to navigate the various settings displayed in that admin panel. This helps WordPress keep the main part of the admin panel clear and concise by eliminating unnecessary text that regular users don't need to see on a regular basis.
+
WordPress[[Version 3.0]]から、ビルトイン[[管理パネル#Help|管理パネル]]にcontextual helpセクションが含まれており、その管理パネルに表示される様々な設定をナビゲートする追加情報を提供します。普段使うユーザーが普段は見る必要のないテキストを見えなくすることで、WordPressの管理パネルの主パートは簡潔かつ正確にします。
  
If your plugin adds additional Administration Panels to WordPress, you can improve support by by providing contextual help for your menus.
+
プラグインに追加の管理パネルを追加する場合、メニューにcontextual helpを追加することで、より良いサポートができます。
  
For information, see [[Adding Administration Menus]] and the [[Plugin API]] functions for a basic overview of how to add Administration Menus to WordPress with a Plugin.
+
プラグインに関して、WordPressに管理メニューを追加する方法についての基本的な概要については、[[管理メニューの追加]][[プラグイン_API]]関数をごらんください。
  
== Every Plot Needs a Hook ==
+
== プロット毎にフックが必要 ==
  
To register a function with WordPress to add a new administration menu, the code is:
+
WordPressに新しい管理メニューを追加する関数は、以下のようになります。
  
 
<pre>
 
<pre>
24行目: 24行目:
 
</pre>
 
</pre>
  
In order for your contextual help menu to know which admin screen it should go to, it needs a way of knowing which panel you want. Fortunately, when we add our admin panel, WordPress is able to return a ''hook'' -- a unique identifier for your panel. To use this, just modify the previous function:
+
contextual helpメニューをどの管理画面で表示するか知るために、パネルを知る方法が必要です。幸運にも、管理パネルを追加するとき、WordPressは''フック''、つまり管理パネルの一意識別子、を返すことができます。これを使用するように直前の関数を変更します。
  
 
<pre>
 
<pre>
39行目: 39行目:
 
</pre>
 
</pre>
  
Notice that we have globalized the hook, because you'll need to use it later on outside of this function.
+
フックをグローバル化したことに注意してください。この関数の外で使用する必要があるからです。
  
== Adding The Contextual Help Function ==
+
== Contextual Help関数を追加する ==
  
As of WordPress 3.0, contextual help menus require three parameters to be passed to it. The first parameter, <tt>$contextual_help</tt>, will be replaced by our function with the contents of our contextual help to be outputted to the browser. The other two parameters, <tt>$screen_id</tt> and <tt>$screen</tt> are used to identify the page that we're on.
+
WordPress 3.0 ではcontextual helpメニューに3つのパラメータを渡す必要があります。第一のパラメータ、 <tt>$contextual_help</tt>は、この関数によって、ブラウザに出力されるcontextual helpの中身に変更されます。残りの2つのパラメータ、<tt>$screen_id</tt><tt>$screen</tt>は、実行するページを同定するのに使用します。
  
 
<pre>
 
<pre>
61行目: 61行目:
 
</pre>
 
</pre>
  
By globalizing <tt>$my_plugin_hook</tt> from earlier, you can check if it matches <tt>$screen_id</tt>. If these don't match, then the user is not viewing this admin panel, so it simply passes along the <tt>$contextual_help</tt> value to the next hooked function.
+
前にグローバル化した<tt>$my_plugin_hook</tt>により、<tt>$screen_id</tt>と一致するかどうかチェックすることができます。一致しない場合は、利用者はこの管理パネルを閲覧していないので、<tt>$contextual_help</tt>の値をそのまま次にフックされている関数に渡します。
  
Also notice that the function has three parameters passed to it, so add <tt>10, 3</tt> to our <tt>add_action()</tt> call so that WordPress is aware of the extra parameters.
+
この関数には3つのパラメータが渡されるので、<tt>add_action()</tt>コールに<tt>10, 3</tt>を追加し、追加のパラメータがあることをWordPressに知らせることに注意してください。
  
== Other Usages ==
+
== その他の使い方 ==
  
If your Administration Panel features a number of different screens during its operation (for example, you have one screen for viewing items, another for adding them, editing them, deleting them, etc.), use additional logic within this function (such as testing for values of <tt>$_POST</tt> or <tt>$_GET</tt>) to provide different versions of help for your panel. If you do this, you may want to offload your help content to a separate PHP file within your Plugin, which you can include within your help function and refer to.
+
管理パネルは操作中に様々な異なる表示をする場合(例えば、1つの画面で項目の閲覧、追加、編集、削除等を行う)(<tt>$_POST</tt><tt>$_GET</tt>の値を調べる等で)この関数に追加ロジックを使用して異なるバージョンのhelpを提供することができます。これを行う場合、プラグイン内の別のPHPファイルにhelpコンテンツを分離して、関数でincludeして参照できるようにしたいかもしれません。
  
It has also been noted that if you were to use object-oriented programming (OOP) in your Plugin and all of your hook functions were part of a class, you could simply make your admin panel hook be a property of your class, thus eliminating the need to globalize it twice.
+
オブジェクト指向プログラミング(OOP)を使用してプラグインを作る場合、全てのフック関数はクラスの一部となり、管理パネルフックもクラスのプロパティとなり、再びグローバル化する必要がないことに注意してください。
  
 
{{原文|Adding Contextual Help to Administration Menus|91876}}<!-- 21:27, 7 August 2010 Lorelle 版 -->
 
{{原文|Adding Contextual Help to Administration Menus|91876}}<!-- 21:27, 7 August 2010 Lorelle 版 -->
  
 
[[Category:New_page_created]] [[Category:Administration]] [[Category:プラグイン]] [[Category:上級トピック]] [[Category:wp3.0]]
 
[[Category:New_page_created]] [[Category:Administration]] [[Category:プラグイン]] [[Category:上級トピック]] [[Category:wp3.0]]

2010年11月22日 (月) 20:22時点における版

この項目「Adding Contextual Help to Administration Menus」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

はじめに

WordPressVersion 3.0から、ビルトイン管理パネルにcontextual helpセクションが含まれており、その管理パネルに表示される様々な設定をナビゲートする追加情報を提供します。普段使うユーザーが普段は見る必要のないテキストを見えなくすることで、WordPressの管理パネルの主パートは簡潔かつ正確にします。

プラグインに追加の管理パネルを追加する場合、メニューにcontextual helpを追加することで、より良いサポートができます。

プラグインに関して、WordPressに管理メニューを追加する方法についての基本的な概要については、管理メニューの追加プラグイン_API関数をごらんください。

プロット毎にフックが必要

WordPressに新しい管理メニューを追加する関数は、以下のようになります。

<?php
add_action('admin_menu', 'my_plugin_menu');

function my_plugin_menu() {

 	add_options_page('My Plugin Options', 'My Plugin', 'manage_options', 'my-unique-identifier', 'my_plugin_options');

}
?>

contextual helpメニューをどの管理画面で表示するか知るために、パネルを知る方法が必要です。幸運にも、管理パネルを追加するとき、WordPressはフック、つまり管理パネルの一意識別子、を返すことができます。これを使用するように直前の関数を変更します。

<?php
add_action('admin_menu', 'my_plugin_menu');

function my_plugin_menu() {

 	global $my_plugin_hook;
 	$my_plugin_hook = add_options_page('My Plugin Options', 'My Plugin', 'manage_options', 'my-unique-identifier', 'my_plugin_options');

}
?>

フックをグローバル化したことに注意してください。この関数の外で使用する必要があるからです。

Contextual Help関数を追加する

WordPress 3.0 ではcontextual helpメニューに3つのパラメータを渡す必要があります。第一のパラメータ、 $contextual_helpは、この関数によって、ブラウザに出力されるcontextual helpの中身に変更されます。残りの2つのパラメータ、$screen_id$screenは、実行するページを同定するのに使用します。

<?php
function my_plugin_help($contextual_help, $screen_id, $screen) {

	global $my_plugin_hook;
	if ($screen_id == $my_plugin_hook) {

		$contextual_help = 'This is where I would provide help to the user on how everything in my admin panel works. Formatted HTML works fine in here too.';
	}
	return $contextual_help;
}

add_action('contextual_help', 'my_plugin_help', 10, 3);
?>

前にグローバル化した$my_plugin_hookにより、$screen_idと一致するかどうかチェックすることができます。一致しない場合は、利用者はこの管理パネルを閲覧していないので、$contextual_helpの値をそのまま次にフックされている関数に渡します。

この関数には3つのパラメータが渡されるので、add_action()コールに10, 3を追加し、追加のパラメータがあることをWordPressに知らせることに注意してください。

その他の使い方

管理パネルは操作中に様々な異なる表示をする場合(例えば、1つの画面で項目の閲覧、追加、編集、削除等を行う)、($_POST$_GETの値を調べる等で)この関数に追加ロジックを使用して異なるバージョンのhelpを提供することができます。これを行う場合、プラグイン内の別のPHPファイルにhelpコンテンツを分離して、関数でincludeして参照できるようにしたいかもしれません。

オブジェクト指向プログラミング(OOP)を使用してプラグインを作る場合、全てのフック関数はクラスの一部となり、管理パネルフックもクラスのプロパティとなり、再びグローバル化する必要がないことに注意してください。

最新英語版: WordPress Codex » Adding Contextual Help to Administration Menus最新版との差分