概要
wp_editor関数は、WordPressでリッチテキストエディタを表示するための便利な関数です。主に次のような機能を実装する際によく使われます：
- 投稿編集画面のカスタマイズ
- プラグイン設定ページでのコンテンツ入力
- ユーザー向けの情報提供ページ作成
- カスタムメタボックスの作成
- コミュニティフォーラムやQ&Aサイトでの投稿
- コメントフォームの拡張
- ショートコードを使用したコンテンツ生成
- ウィジェットエディタの拡張
wp_editor関数の構文は以下の通りです：
wp_editor( $content, $editor_id, $settings );
パラメータ
$content(string): エディタに初期表示するコンテンツ。$editor_id(string): エディタの識別子。他のエディタと区別するために使用。$settings(array): エディタの設定を指定。ツールバーやメディアボタンの表示を制御。
戻り値
- なし:
wp_editor関数はエディタのHTMLを出力しますが、値を返すことはありません。
関連する関数
使用可能なバージョン
wp_editorはWordPress 3.3以降で使用可能です。
コアファイルのパス
wp-includes/class-wp-editor.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | 〇 |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
- 特に非推奨または削除されたバージョンはありません。