Changeset 32654 for trunk/src/wp-admin/custom-header.php

Timestamp:

05/29/2015 08:16:22 PM (11 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to wp-admin/includes/*.
Fix some egregious uses of tabbing.
Some functions can simply return apply_filters(...) instead of setting a variable that is immediately returned.

See #32444.

File:

• trunk/src/wp-admin/custom-header.php (modified) (12 diffs)

trunk/src/wp-admin/custom-header.php

@@ -318 +318 @@
                 }
                 ?>
-
 <script type="text/javascript">
 (function($){
@@ -926 +925 @@
          *
          * @since 3.4.0
+         *
+         * @param array $form_fields
+         * @return $form_fields
          */
         public function attachment_fields_to_edit( $form_fields ) {
@@ -935 +937 @@
          *
          * @since 3.4.0
+         *
+         * @param array $tabs
+         * @return $tabs
          */
         public function filter_upload_tabs( $tabs ) {
@@ -951 +956 @@
          *
          * @since 3.4.0
+         *
+         * @param array|object|string $choice
          */
         final public function set_header_image( $choice ) {
@@ -1002 +1009 @@
          */
         final public function remove_header_image() {
-                return $this->set_header_image( 'remove-header' );
+                $this->set_header_image( 'remove-header' );
         }
 
@@ -1016 +1023 @@
                 $default = get_theme_support( 'custom-header', 'default-image' );
 
-                if ( ! $default )
-                        return $this->remove_header_image();
-
+                if ( ! $default ) {
+                        $this->remove_header_image();
+                        return;
+                }
                 $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
 
@@ -1036 +1044 @@
          * Calculate width and height based on what the currently selected theme supports.
          *
+         * @param array $dimensions
          * @return array dst_height and dst_width of header image.
          */
@@ -1085 +1094 @@
          * Create an attachment 'object'.
          *
-         * @param string $cropped Cropped image URL.
-         * @param int $parent_attachment_id Attachment ID of parent image.
+         * @param string $cropped              Cropped image URL.
+         * @param int    $parent_attachment_id Attachment ID of parent image.
          *
          * @return array Attachment object.
@@ -1113 +1122 @@
          * Insert an attachment and its metadata.
          *
-         * @param array $object Attachment object.
+         * @param array  $object  Attachment object.
          * @param string $cropped Cropped image URL.
          *
@@ -1241 +1250 @@
         }
 
+        /**
+         *
+         * @param WP_Customize_Manager $wp_customize
+         */
         public function customize_set_last_used( $wp_customize ) {
                 $data = $wp_customize->get_setting( 'header_image_data' )->post_value();
@@ -1253 +1266 @@
         }
 
+        /**
+         *
+         * @return array
+         */
         public function get_default_header_images() {
                 $this->process_default_headers();
@@ -1286 +1303 @@
 
                 // The rest of the set comes after.
-                $header_images = array_merge( $header_images, $this->default_headers );
-                return $header_images;
-        }
-
+                return array_merge( $header_images, $this->default_headers );
+        }
+
+        /**
+         *
+         * @return array
+         */
         public function get_uploaded_header_images() {
                 $header_images = get_uploaded_header_images();