Ticket #40231: 40231.6.diff

src/wp-admin/custom-header.php

@@ -42 +42 @@
 
         /**
          * Used to trigger a success message when settings updated and set to true.
-         *
+         *
          * @since 3.0.0
          * @access private
          * @var bool
@@ -1097 +1097 @@
         /**
          * Calculate width and height based on what the currently selected theme supports.
          *
+         * @since 3.9.0
+         *
          * @param array $dimensions
          * @return array dst_height and dst_width of header image.
          */
@@ -1147 +1149 @@
         /**
          * Create an attachment 'object'.
          *
+         * @since 3.9.0
+         *
          * @param string $cropped              Cropped image URL.
          * @param int    $parent_attachment_id Attachment ID of parent image.
-         *
          * @return array Attachment object.
          */
         final public function create_attachment_object( $cropped, $parent_attachment_id ) {
@@ -1174 +1177 @@
         /**
          * Insert an attachment and its metadata.
          *
+         * @since 3.9.0
+         *
          * @param array  $object  Attachment object.
          * @param string $cropped Cropped image URL.
-         *
          * @return int Attachment ID.
          */
         final public function insert_attachment( $object, $cropped ) {
@@ -1199 +1203 @@
         /**
          * Gets attachment uploaded by Media Manager, crops it, then saves it as a
          * new object. Returns JSON-encoded object details.
+         *
+         * @since 3.9.0
          */
         public function ajax_header_crop() {
                 check_ajax_referer( 'image_editor-' . $_POST['id'], 'nonce' );
@@ -1257 +1263 @@
          *
          * Triggered when the user tries adds a new header image from the
          * Media Manager, even if s/he doesn't save that change.
+         *
+         * @since 3.9.0
          */
         public function ajax_header_add() {
                 check_ajax_referer( 'header-add', 'nonce' );
@@ -1283 +1291 @@
          *
          * Triggered when the user clicks the overlay "X" button next to each image
          * choice in the Customizer's Header tool.
+         *
+         * @since 3.9.0
          */
         public function ajax_header_remove() {
                 check_ajax_referer( 'header-remove', 'nonce' );
@@ -1304 +1314 @@
         }
 
         /**
+         * Updates the last-used postmeta on a header image attachment after saving a new header image via the customizer.
          *
-         * @param WP_Customize_Manager $wp_customize
+         * @since 3.9.0
+         *
+         * @param WP_Customize_Manager $wp_customize Customize manager.
          */
         public function customize_set_last_used( $wp_customize ) {
                 $data = $wp_customize->get_setting( 'header_image_data' )->post_value();
@@ -1320 +1333 @@
         }
 
         /**
+         * Gets the details of default header images if defined.
+         *
+         * @since 3.9.0
          *
-         * @return array
+         * @return array Default header images.
          */
         public function get_default_header_images() {
                 $this->process_default_headers();
@@ -1360 +1376 @@
         }
 
         /**
+         * Gets the previously uploaded header images.
+         *
+         * @since 3.9.0
          *
-         * @return array
+         * @return array Uploaded header images.
          */
         public function get_uploaded_header_images() {
                 $header_images = get_uploaded_header_images();