Changeset 40788

Timestamp:

05/19/2017 03:52:07 AM (8 years ago)

Author:

westonruter

Message:

Docs: Add missing @since tags and phpdoc descriptions to the Custom_Image_Header class.

Amends [27497].
Props tejas5989, riddhiehta02, westonruter.
See #21785.
Fixes #40231.

File:

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

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

@@ -43 +43 @@
     /**
      * Used to trigger a success message when settings updated and set to true.
-     *
+     *
      * @since 3.0.0
      * @access private
@@ -1098 +1098 @@
      * 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.
@@ -1148 +1150 @@
      * 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.
      */
@@ -1175 +1178 @@
      * 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.
      */
@@ -1200 +1204 @@
      * 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() {
@@ -1258 +1264 @@
      * 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() {
@@ -1284 +1292 @@
      * 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() {
@@ -1305 +1315 @@
 
     /**
-     *
-     * @param WP_Customize_Manager $wp_customize
+     * Updates the last-used postmeta on a header image attachment after saving a new header image via the Customizer.
+     *
+     * @since 3.9.0
+     *
+     * @param WP_Customize_Manager $wp_customize Customize manager.
      */
     public function customize_set_last_used( $wp_customize ) {
@@ -1321 +1334 @@
 
     /**
-     *
-     * @return array
+     * Gets the details of default header images if defined.
+     *
+     * @since 3.9.0
+     *
+     * @return array Default header images.
      */
     public function get_default_header_images() {
@@ -1361 +1377 @@
 
     /**
-     *
-     * @return array
+     * Gets the previously uploaded header images.
+     *
+     * @since 3.9.0
+     *
+     * @return array Uploaded header images.
      */
     public function get_uploaded_header_images() {