[wp-trac] [WordPress Trac] #34866: Improve documentation for format_for_editor()

WordPress Trac noreply at wordpress.org
Sun Dec 6 17:28:55 UTC 2015

#34866: Improve documentation for format_for_editor()
 Reporter:  swissspidy    |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  Editor        |    Version:
 Severity:  normal        |   Keywords:  needs-patch good-first-bug
  Focuses:  docs          |
 `format_for_editor()` has an optional `$default_editor` parameter that I
 ''think'' is either passed `'html'` or `'text'`. It's totally not
 documented and could need some love.

 See also the `the_editor_content` filter where `format_for_editor()` is
 applied to. `$default_editor` needs to be documented there as well.

 See the [https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/php/#docblock-formatting PHP documentation
 standards] for formatting details.

Ticket URL: <https://core.trac.wordpress.org/ticket/34866>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform

More information about the wp-trac mailing list