Функция wp_editor() в WordPress: использование и параметры

Функция wp_editor() в WordPress

Функция wp_editor() используется для создания редактора контента на вашем сайте на WordPress. Это правильный способ для отображения всех необходимых компонентов для редакторов TinyMCE и Quicktags. Не рекомендуется использовать класс _WP_Editors напрямую.

Замечания

  • Важно: После инициализации редактора TinyMCE его нельзя безопасно перемещать в дереве DOM. Поэтому использование функции wp_editor() внутри мета-бокса не рекомендуется, если вы используете только Quicktags. В редакторе постов есть несколько действий, которые можно использовать для добавления дополнительных редакторов с TinyMCE: edit_page_form, edit_form_advanced и dbx_post_sidebar.

Возврат значения

Функция возвращает null, то есть ничего не возвращает.

Использование функции

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

Параметры

  • $content (string) (обязательный) — Начальное содержимое для редактора.
  • $editor_id (string) (обязательный) — Значение атрибута HTML ID для текстового поля и TinyMCE. Не должно содержать квадратные скобки.
  • $settings (array) — Дополнительные настройки. Смотрите описание метода _WP_Editors::parse_settings() для более подробной информации. По умолчанию: array().

Примеры использования

Пример 1: Изменение настроек формы

Можно изменить настройки формы, если вам не нравятся базовые настройки. Например, чтобы убрать кнопку "Добавить медиафайл":

$settings = array( 'media_buttons' => false );
wp_editor( $content, $editor_id, $settings );

Пример 2: TinyMCE на страницах сайта

Чтобы отобразить текстовое поле с редактором TinyMCE и HTML-редактором на страницах сайта, вставьте следующий код в файл шаблона:

 'content' ] ); ?>

Пример 3: Заполнение поля содержимым поста

Если вы хотите заполнить редактор содержимым определённого поста (например, поста с ID 51), вы можете использовать следующий код:

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

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

wp_editor( $content, $editor_id );

Примечания

История изменений

  • Версия: 3.3.0 — функция была введена в WordPress.

Код функции

Вот как выглядит код функции wp_editor():

function wp_editor( $content, $editor_id, $settings = array() ) {
    if ( ! class_exists( '_WP_Editors', false ) ) {
        require ABSPATH . WPINC . '/class-wp-editor.php';
    }
    _WP_Editors::editor( $content, $editor_id, $settings );
}

Эта функция загружает нужные классы и вызывает метод editor для отображения редактора.

Связанные функции

  • _doing_it_wrong()
  • cache_javascript_headers()
  • do_robots()
  • download_url()
  • get_privacy_policy_url()
  • maybe_convert_table_to_utf8mb4()
  • nocache_headers()
  • show_admin_bar()
  • wp_check_browser_version()
  • wp_die()
  • wp_get_raw_referer()
  • wp_get_referer()
  • wp_install_defaults()
  • wp_magic_quotes()
  • wp_mail()
  • wp_oembed_get()
  • wp_redirect()
  • wp_safe_redirect()
  • wp_star_rating()
  • wp_timezone_choice()
  • wp_validate_redirect()

С помощью функции wp_editor() вы можете легко добавлять мощные текстовые редакторы на страницы вашего сайта WordPress, улучшая взаимодействие с пользователями.

Leave a Reply

Ваш адрес email не будет опубликован. Обязательные поля помечены *