<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[27808] trunk/src/wp-includes/class-wp-editor.php: Convert `wp_editor()` default arguments documentation to a hash notation in the `_WP_Editors::parse_settings()` PHPDoc.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27808">27808</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-03-28 05:45:54 +0000 (Fri, 28 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Convert `wp_editor()` default arguments documentation to a hash notation in the `_WP_Editors::parse_settings()` PHPDoc.
See <a href="http://core.trac.wordpress.org/ticket/27566">#27566</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpeditorphp">trunk/src/wp-includes/class-wp-editor.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpeditorphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-editor.php (27807 => 27808)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-editor.php 2014-03-28 05:42:49 UTC (rev 27807)
+++ trunk/src/wp-includes/class-wp-editor.php 2014-03-28 05:45:54 UTC (rev 27808)
</span><span class="lines">@@ -27,21 +27,52 @@
</span><span class="cx">
</span><span class="cx"> private function __construct() {}
</span><span class="cx">
</span><del>- public static function parse_settings($editor_id, $settings) {
</del><ins>+ /**
+ * Parse _WP_Editors settings.
+ *
+ * @param string $editor_id ID for the current editor isntance.
+ * @param array $settings {
+ * Array of editor arguments.
+ *
+ * @type bool $wpautop Whether to use wpautop(). Default true.
+ * @type bool $media_buttons Whether to show the Add Media/other media buttons.
+ * @type string $default_editor When both TinyMCE and Quicktags are used, set which
+ * editor is shown on page load. Default empty.
+ * @type string $textarea_name Give the textarea a unique name here. Square brackets
+ * can be used here. Default $editor_id.
+ * @type int $textarea_rows Number rows in the editor textarea. Default 20.
+ * @type string|int $tabindex Tabindex value to use. Default empty.
+ * @type string $tabfocus_elements The previous and next element ID to move the focus to
+ * when pressing the Tab key in TinyMCE. Defualt ':prev,:next'.
+ * @type string $editor_css Intended for extra styles for both Visual and Text editors.
+ * Should include <style> tags, and can use "scoped". Default empty.
+ * @type string $editor_class Extra classes to add to the editor textarea elemen. Default empty.
+ * @type bool $teeny Whether to output the minimal editor config. Examples include
+ * Press This and the Comment editor. Default false.
+ * @type bool $dfw Whether to replace the default fullscreen with "Distraction Free
+ * Writing". DFW requires specific DOM elements and css). Default false.
+ * @type bool|array $tinymce Whether to load TinyMCE. Can be used to pass settings directly to
+ * TinyMCE using an array. Default true.
+ * @type bool|array $quicktags Whether to load Quicktags. Can be used to pass settings directly to
+ * Quicktags using an array. Default true.
+ * }
+ * @return array Parsed arguments array.
+ */
+ public static function parse_settings( $editor_id, $settings ) {
</ins><span class="cx"> $set = wp_parse_args( $settings, array(
</span><del>- 'wpautop' => true, // use wpautop?
- 'media_buttons' => true, // show insert/upload button(s)
- 'default_editor' => '', // When both TinyMCE and Quicktags are used, set which editor is shown on loading the page
- 'textarea_name' => $editor_id, // set the textarea name to something different, square brackets [] can be used here
- 'textarea_rows' => 20,
- 'tabindex' => '',
- 'tabfocus_elements' => ':prev,:next', // the previous and next element ID to move the focus to when pressing the Tab key in TinyMCE
- 'editor_css' => '', // intended for extra styles for both visual and Text editors buttons, needs to include the <style> tags, can use "scoped".
- 'editor_class' => '', // add extra class(es) to the editor textarea
- 'teeny' => false, // output the minimal editor config used in Press This
- 'dfw' => false, // replace the default fullscreen with DFW (needs specific DOM elements and css)
- 'tinymce' => true, // load TinyMCE, can be used to pass settings directly to TinyMCE using an array()
- 'quicktags' => true // load Quicktags, can be used to pass settings directly to Quicktags using an array()
</del><ins>+ 'wpautop' => true,
+ 'media_buttons' => true,
+ 'default_editor' => '',
+ 'textarea_name' => $editor_id,
+ 'textarea_rows' => 20,
+ 'tabindex' => '',
+ 'tabfocus_elements' => ':prev,:next',
+ 'editor_css' => '',
+ 'editor_class' => '',
+ 'teeny' => false,
+ 'dfw' => false,
+ 'tinymce' => true,
+ 'quicktags' => true
</ins><span class="cx"> ) );
</span><span class="cx">
</span><span class="cx"> self::$this_tinymce = ( $set['tinymce'] && user_can_richedit() );
</span></span></pre>
</div>
</div>
</body>
</html>