[wp-trac] [WordPress Trac] #37535: Outputting Post Type Description on admin edit screen

[WordPress Trac]

#37535: Outputting Post Type Description on admin edit screen
-------------------------------------------------+-------------------------
 Reporter:  simonrcodrington                     |       Owner:
     Type:  enhancement                          |      Status:  new
 Priority:  normal                               |   Milestone:  Awaiting
Component:  Posts, Post Types                    |  Review
 Severity:  normal                               |     Version:  4.6
 Keywords:  has-patch ui-feedback has-           |  Resolution:
  screenshots                                    |     Focuses:  ui,
                                                 |  administration
-------------------------------------------------+-------------------------

Comment (by simonrcodrington):

 Hey Mike, thanks for having a look at this ticket.

 The way I see the `description` arg being useful when registering post
 types is by providing useful info about what this post type does / can do.
 For example on staff content types I've dynamically outputted text on the
 admin posts pages (via JS) that's helpful to the site admins / users,
 letting them know what this content type is and how to manage it.

 From what I see, I don't think the description is used anywhere, which is
 a real waste as it should live on the posts admin page as that's where
 most people will spend their time managing content..

 In regards to the field. When you pass your description as an argument you
 can only pass in text. I'm not sure what would happen if you pass in a
 string that's actually a HTML block. When it's being outputted in my
 proposed code above I've ran it through `esc_html` but it could easily be
 adjusted on the output side (or via a filter?)

 It would be great to get more feedback on this.  It's a small change, but
 overall would make explaining to people what all these content types do
 easier.

 Replying to [comment:7 mikeschroder]:
 > Immediate thoughts--
 >
 > Like this idea.
 >
 > Top of mind concerns would be:
 > - Current use cases for the description field -- as you stated, if it's
 not being output in the admin, what are the current expections/widest uses
 for the field?
 > - Is there content not suitable for display that developers are storing
 in them, since there's no expectation of admin output?

--
Ticket URL: <https://core.trac.wordpress.org/ticket/37535#comment:8>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform