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

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

「関数リファレンス/wp editor」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function_Reference/wp_editor 05:31, 16 February 2015‎‎ Mfrerebeau 版)
 
(翻訳)
1行目: 1行目:
==Description==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
This function renders an editor in a page in the typical fashion used in Posts and Pages.
+
投稿や固定ページで使用される標準エディターを表示します。
  
==Usage==
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
 
  <?php wp_editor( $content, $editor_id, $settings = array() ); ?>  
 
  <?php wp_editor( $content, $editor_id, $settings = array() ); ?>  
  
==Parameters==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
{{Parameter|$content|string|Initial content for the editor.}}
+
{{Parameter|$content|文字列|エディタに最初から表示させておく文字列。}}
{{Parameter|$editor_id|string|HTML <tt>id</tt> attribute value for the textarea and TinyMCE. ('''may only contain lowercase letters and underscores...hyphens will cause editor to not display properly''')}}
+
{{Parameter|$editor_id|文字列|テキストエリアとTinyMCEに指定するIDを指定。 ('''小文字とアンダースコアが使用できます。ハイフンを使用するとエディタが正しく表示されないことが有ります。''')}}
{{Parameter|$settings|array|An array of arguments.|optional|<tt>array()</tt>}}
+
{{Parameter|$settings|配列|引数の配列|optional|<tt>array()</tt>}}
  
=== Arguments ===
+
<div id="Arguments">
 +
== 引数 ==
 +
</div>
  
{{Parameter|wpautop|boolean|Whether to use wpautop for adding in paragraphs. Note that the paragraphs are added automatically when wpautop is false.|optional|<tt>true</tt>}}
+
{{Parameter|wpautop|論理値|[[関数リファレンス/wpautop|wpautop]]を使用するか。falseにすると、段落は自動的に追加されます。|optional|<tt>true</tt>}}
  
{{Parameter|media_buttons|boolean|Whether to display media insert/upload buttons|optional|<tt>true</tt>}}
+
{{Parameter|media_buttons|論理値|メディアボタンを追加するか。|optional|<tt>true</tt>}}
  
{{Parameter|textarea_name|string|The name assigned to the generated textarea and passed parameter when the form is submitted. ('''may include [] to pass data as array''')|optional|<tt>$editor_id</tt>}}
+
{{Parameter|textarea_name|文字列|テキストエリアに割り当てるname属性値を指定します。 ('''配列などのデータを渡すため[]が含むことも可能です。''')|optional|<tt>$editor_id</tt>}}
  
{{Parameter|textarea_rows|integer|The number of rows to display for the textarea|optional|<tt>get_option('default_post_edit_rows', 10)</tt>}}
+
{{Parameter|textarea_rows|数値|テキストエリアの行数を指定します。|optional|<tt>get_option('default_post_edit_rows', 10)</tt>}}
  
{{Parameter|tabindex|integer|The tabindex value used for the form field|optional}}
+
{{Parameter|tabindex|数値|フォームフィールドに使用されるtabindex属性値を指定します。|optional}}
  
{{Parameter|editor_css|string|Additional CSS styling applied for both visual and HTML editors buttons, needs to include <tt><style></tt> tags, can use "scoped"|optional}}
+
{{Parameter|editor_css|文字列|見た目と、HTMLエディタの見た目を変更するCSSのスタイルを指定します。 <tt><style></tt>タグが含まれている必要があり、"scoped"属性を使用することが出来ます。|optional}}
  
{{Parameter|editor_class|string|Any extra CSS Classes to append to the Editor textarea|optional|Empty string}}
+
{{Parameter|editor_class|文字列|テキストエリアにCSS classを指定します。|optional|Empty string}}
  
{{Parameter|teeny|boolean|Whether to output the minimal editor configuration used in PressThis|optional|<tt>false</tt>}}
+
{{Parameter|teeny|論理値|最小限のエディタを使用するかどうか。最小限のエディタはPressThisの設定を使用します。|optional|<tt>false</tt>}}
  
{{Parameter|dfw|boolean|Whether to replace the default fullscreen editor with DFW ('''needs specific DOM elements and CSS''')|optional|false}}
+
{{Parameter|dfw|論理値|標準のフルスクリーンモード(DFW)に置き換えるか。('''特定のDOM要素とCSSを必要とします。''')|optional|false}}
  
{{Parameter|tinymce|array|Load TinyMCE, can be used to pass settings directly to TinyMCE using an array|optional|<tt>true</tt>}}
+
{{Parameter|tinymce|配列|TinyMCEを読み込むか。配列を使用して、TinyMCEの設定を行うことが出来ます。|optional|<tt>true</tt>}}
  
{{Parameter|quicktags|array|Load Quicktags, can be used to pass settings directly to Quicktags using an array. Set to false to remove your editor's Visual and Text tabs.|optional|<tt>true</tt>}}
+
{{Parameter|quicktags|array|Quicktagsを読み込むか。配列を使用して、Quicktagsの設定を行うことが出来ます。falseを指定するとビジュアルとテキストのタブが削除されます。|optional|<tt>true</tt>}}
  
{{Parameter|drag_drop_upload|boolean|Enable Drag & Drop Upload Support ('''since WordPress 3.9''')|optional|<tt>false</tt>}}
+
{{Parameter|drag_drop_upload|論理値|ドラッグ&ドロップでファイルのアップロードの機能を使用するか。('''WordPress 3.9から使用可''')|optional|<tt>false</tt>}}
  
== Return Values ==
+
<div id="Return_Values">
 +
== 戻り値 ==
 +
</div>
  
This function does not return a value.
+
この関数は値を返しません。
  
== Examples ==
+
<div id="Examples">
 +
== 例 ==
 +
</div>
  
Display an empty editor using the default settings:
+
デフォルトの設定を使用して、空のテキストエディタを表示します。
  
 
<pre>
 
<pre>
58行目: 70行目:
 
</pre>
 
</pre>
  
Fill an editor with the content for a particular post:
+
特定の記事の内容と、エディタを表示します。
  
 
<pre>
 
<pre>
74行目: 86行目:
 
</pre>
 
</pre>
  
We can also pass an array of one or more settings if the defaults don't suit our needs. For example, if we wanted to hide the insert media buttons, we would do this:
+
デフォルトの設定では問題がある場合、1つ以上の設定の配列を渡すことが可能です。
 +
例えば、メディアボタンを非表示にしたい場合は以下のように設定します。
  
 
<pre>
 
<pre>
86行目: 99行目:
 
</pre>
 
</pre>
  
== Notes ==
+
<div id="Notes">
 +
== 参考 ==
 +
</div>
  
* Note that the ID that is passed to the <tt>wp_editor()</tt> function can only be composed of lower-case letters.  No underscores, no hyphens.  Anything else will cause the WYSIWYG editor to malfunction. (As of 3.6.1 you can use underscores in the ID.)
+
* wp_editor()関数に渡されるIDは小文字のみで構成する事ができることに注意してください。下線やハイフンを使用することは出来ません。他の文字を使用すると、WYSIWYGエディタの破損の原因となります。(3.6.1からはIDに下線を使用することが出来ます。)
  
 
* Once instantiated, the WYSIWYG editor cannot be moved around in the DOM.  What this means in practical terms, is that you cannot put it in meta-boxes that can be dragged and placed elsewhere on the page. Instead use <tt>'edit_page_form'</tt> (for pages) or <tt>'edit_form_advanced'</tt> (for other post types):
 
* Once instantiated, the WYSIWYG editor cannot be moved around in the DOM.  What this means in practical terms, is that you cannot put it in meta-boxes that can be dragged and placed elsewhere on the page. Instead use <tt>'edit_page_form'</tt> (for pages) or <tt>'edit_form_advanced'</tt> (for other post types):
99行目: 114行目:
 
</pre>
 
</pre>
  
== Change Log ==
+
<div id="Change Log">
 +
== 変更履歴 ==
 +
</div>
  
 
* Since [[Version 3.3|3.3]]
 
* Since [[Version 3.3|3.3]]
  
== Source Code ==
+
<div id="Source File">
 +
== ソースファイル ==
 +
</div>
  
<code>wp_editor()</code> is located in {{Trac|wp-includes/general-template.php}}
+
<code>wp_editor()</code> {{Trac|wp-includes/general-template.php}} にあります。
  
== Related ==
+
<div id="Related">
 +
== 関連項目 ==
 +
</div>
  
 
{{Editor Tags}}
 
{{Editor Tags}}

2015年5月1日 (金) 16:53時点における版

投稿や固定ページで使用される標準エディターを表示します。

使い方

<?php wp_editor( $content, $editor_id, $settings = array() ); ?> 

パラメータ

$content
文字列) (必須) エディタに最初から表示させておく文字列。
初期値: なし
$editor_id
文字列) (必須) テキストエリアとTinyMCEに指定するIDを指定。 (小文字とアンダースコアが使用できます。ハイフンを使用するとエディタが正しく表示されないことが有ります。)
初期値: なし
$settings
配列) (optional) 引数の配列
初期値: array()

引数

wpautop
論理値) (optionalwpautopを使用するか。falseにすると、段落は自動的に追加されます。
初期値: true
media_buttons
論理値) (optional) メディアボタンを追加するか。
初期値: true
textarea_name
文字列) (optional) テキストエリアに割り当てるname属性値を指定します。 (配列などのデータを渡すため[]が含むことも可能です。)
初期値: $editor_id
textarea_rows
数値) (optional) テキストエリアの行数を指定します。
初期値: get_option('default_post_edit_rows', 10)
tabindex
数値) (optional) フォームフィールドに使用されるtabindex属性値を指定します。
初期値: なし
editor_css
文字列) (optional) 見た目と、HTMLエディタの見た目を変更するCSSのスタイルを指定します。 <style>タグが含まれている必要があり、"scoped"属性を使用することが出来ます。
初期値: なし
editor_class
文字列) (optional) テキストエリアにCSS classを指定します。
初期値: Empty string
teeny
論理値) (optional) 最小限のエディタを使用するかどうか。最小限のエディタはPressThisの設定を使用します。
初期値: false
dfw
論理値) (optional) 標準のフルスクリーンモード(DFW)に置き換えるか。(特定のDOM要素とCSSを必要とします。)
初期値: false
tinymce
配列) (optional) TinyMCEを読み込むか。配列を使用して、TinyMCEの設定を行うことが出来ます。
初期値: true
quicktags
array) (optional) Quicktagsを読み込むか。配列を使用して、Quicktagsの設定を行うことが出来ます。falseを指定するとビジュアルとテキストのタブが削除されます。
初期値: true
drag_drop_upload
論理値) (optional) ドラッグ&ドロップでファイルのアップロードの機能を使用するか。(WordPress 3.9から使用可)
初期値: false

戻り値

この関数は値を返しません。

デフォルトの設定を使用して、空のテキストエディタを表示します。

<?php

$content = '';
$editor_id = 'mycustomeditor';

wp_editor( $content, $editor_id );

?>

特定の記事の内容と、エディタを表示します。

<?php

$post_id = 51;
$post = get_post( $post_id, OBJECT, 'edit' );

$content = $post->post_content;
$editor_id = 'editpost';

wp_editor( $content, $editor_id );

?>

デフォルトの設定では問題がある場合、1つ以上の設定の配列を渡すことが可能です。 例えば、メディアボタンを非表示にしたい場合は以下のように設定します。

<?php

$settings = array( 'media_buttons' => false );

wp_editor( $content, $editor_id, $settings );

?>

参考

  • wp_editor()関数に渡されるIDは小文字のみで構成する事ができることに注意してください。下線やハイフンを使用することは出来ません。他の文字を使用すると、WYSIWYGエディタの破損の原因となります。(3.6.1からはIDに下線を使用することが出来ます。)
  • Once instantiated, the WYSIWYG editor cannot be moved around in the DOM. What this means in practical terms, is that you cannot put it in meta-boxes that can be dragged and placed elsewhere on the page. Instead use 'edit_page_form' (for pages) or 'edit_form_advanced' (for other post types):
add_action( 'edit_page_form', 'my_second_editor' );
function my_second_editor() {
	// get and set $content somehow...
	wp_editor( $content, 'mysecondeditor' );
}

変更履歴

ソースファイル

wp_editor()wp-includes/general-template.php にあります。

エディター関数: wp_editor(), the_editor() / en, wp_default_editor() / en, user_can_richedit() / en