[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-wp-editor.php (summary)

Facilitates adding of the WordPress editor as used on the Write and Edit screens.

File Size: 1867 lines (70 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 0 files

Defines 19 functions

  __construct()
  parse_settings()
  editor()
  editor_settings()
  _parse_init()
  enqueue_scripts()
  enqueue_default_editor()
  print_default_editor_scripts()
  get_mce_locale()
  get_baseurl()
  default_settings()
  get_translation()
  wp_mce_translation()
  force_uncompressed_tinymce()
  print_tinymce_scripts()
  editor_js()
  wp_fullscreen_html()
  wp_link_query()
  wp_link_dialog()

Functions
Functions that are not part of a class:

__construct()   X-Ref
No description

parse_settings( $editor_id, $settings )   X-Ref
Parse default arguments for the editor instance.

param: string $editor_id ID for the current editor instance.
param: array  $settings {
return: array Parsed arguments array.

editor( $content, $editor_id, $settings = array()   X-Ref
Outputs the HTML for a single instance of the editor.

param: string $content The initial content of the editor.
param: string $editor_id ID for the textarea and TinyMCE and Quicktags instances (can contain only ASCII letters and numbers).
param: array $settings See _WP_Editors::parse_settings() for description.

editor_settings( $editor_id, $set )   X-Ref

param: string $editor_id
param: array  $set

_parse_init( $init )   X-Ref

param: array $init
return: string

enqueue_scripts( $default_scripts = false )   X-Ref

param: bool $default_scripts Optional. Whether default scripts should be enqueued. Default false.

enqueue_default_editor()   X-Ref
Enqueue all editor scripts.
For use when the editor is going to be initialized after page load.

since: 4.8.0

print_default_editor_scripts()   X-Ref
Print (output) all editor scripts and default settings.
For use when the editor is going to be initialized after page load.

since: 4.8.0

get_mce_locale()   X-Ref
No description

get_baseurl()   X-Ref
No description

default_settings()   X-Ref
Returns the default TinyMCE settings.
Doesn't include plugins, buttons, editor selector.

return: array

get_translation()   X-Ref
No description

wp_mce_translation( $mce_locale = '', $json_only = false )   X-Ref
Translates the default TinyMCE strings and returns them as JSON encoded object ready to be loaded with tinymce.addI18n(),
or as JS snippet that should run after tinymce.js is loaded.

param: string $mce_locale The locale used for the editor.
param: bool $json_only optional Whether to include the JavaScript calls to tinymce.addI18n() and tinymce.ScriptLoader.markDone().
return: string Translation object, JSON encoded.

force_uncompressed_tinymce()   X-Ref
Force uncompressed TinyMCE when a custom theme has been defined.

The compressed TinyMCE file cannot deal with custom themes, so this makes
sure that we use the uncompressed TinyMCE file if a theme is defined.
Even if we are on a production environment.

print_tinymce_scripts()   X-Ref
Print (output) the main TinyMCE scripts.

since: 4.8.0

editor_js()   X-Ref
Print (output) the TinyMCE configuration and initialization scripts.


wp_fullscreen_html()   X-Ref
Outputs the HTML for distraction-free writing mode.

since: 3.2.0

wp_link_query( $args = array()   X-Ref
Performs post queries for internal linking.

param: array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
return: false|array Results.
since: 3.1.0

wp_link_dialog()   X-Ref
Dialog for internal linking.

since: 3.1.0



Generated: Fri Nov 22 01:00:04 2019 Cross-referenced by PHPXref 0.7.1