[wp-trac] [WordPress Trac] #21410: Misleading function description for check_upload_mimes

[WordPress Trac]

#21410: Misleading function description for check_upload_mimes
-------------------------+-----------------------------
 Reporter:  Cimmo        |      Owner:
     Type:  enhancement  |     Status:  new
 Priority:  normal       |  Milestone:  Awaiting Review
Component:  Multisite    |    Version:  3.4.1
 Severity:  normal       |   Keywords:
-------------------------+-----------------------------
 The description for check_upload_mimes is misleading.
 Specifically "This function is used to filter that list against..." for
 that list seems talks about what returned by get_allowed_mime_types() but
 this is not true, since there is no call to get_allowed_mime_types() in
 the code.

 Instead filter $mimes input array against the filetype whitelist provided
 by Multisite.
 Please fix the description.


 {{{

 /**
  * Check an array of MIME types against a whitelist.
  *
  * WordPress ships with a set of allowed upload filetypes,
  * which is defined in wp-includes/functions.php in
  * get_allowed_mime_types(). This function is used to filter
  * that list against the filetype whitelist provided by Multisite
  * Super Admins at wp-admin/network/settings.php.
  *
  * @since MU
  *
  * @param array $mimes
  * @return array
  */
 function check_upload_mimes( $mimes ) {
 }}}

-- 
Ticket URL: <http://core.trac.wordpress.org/ticket/21410>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software