Remove unnecessary "not used" notation for filter parameters in wp-admin/includes/media.php.

Also add `@param` and `@return` descriptions.

See #28408.


git-svn-id: https://develop.svn.wordpress.org/trunk@28632 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-05-30 17:37:36 +00:00
parent 1a1994b20f
commit dc96d99a70

View File

@ -1028,9 +1028,9 @@ function image_attachment_fields_to_edit($form_fields, $post) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param array $form_fields * @param array $form_fields An array of attachment form fields.
* @param object $post {@internal $post not used}} * @param WP_Post $post The WP_Post attachment object.
* @return array * @return array Filtered attachment form fields.
*/ */
function media_single_attachment_fields_to_edit( $form_fields, $post ) { function media_single_attachment_fields_to_edit( $form_fields, $post ) {
unset($form_fields['url'], $form_fields['align'], $form_fields['image-size']); unset($form_fields['url'], $form_fields['align'], $form_fields['image-size']);
@ -1042,9 +1042,9 @@ function media_single_attachment_fields_to_edit( $form_fields, $post ) {
* *
* @since 2.8.0 * @since 2.8.0
* *
* @param array $form_fields * @param array $form_fields An array of attachment form fields.
* @param object $post {@internal $post not used}} * @param WP_Post $post The WP_Post attachment object.
* @return array * @return array Filtered attachment form fields.
*/ */
function media_post_single_attachment_fields_to_edit( $form_fields, $post ) { function media_post_single_attachment_fields_to_edit( $form_fields, $post ) {
unset($form_fields['image_url']); unset($form_fields['image_url']);
@ -1060,9 +1060,9 @@ function media_post_single_attachment_fields_to_edit( $form_fields, $post ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param object $post * @param WP_Post $post The WP_Post attachment object.
* @param array $attachment {@internal $attachment not used}} * @param array $attachment An array of attachment metadata.
* @return array * @return array Filtered attachment post object.
*/ */
function image_attachment_fields_to_save( $post, $attachment ) { function image_attachment_fields_to_save( $post, $attachment ) {
if ( substr( $post['post_mime_type'], 0, 5 ) == 'image' ) { if ( substr( $post['post_mime_type'], 0, 5 ) == 'image' ) {