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

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

関数リファレンス/wp editor

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

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

使い方

<?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


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