WordPress.org

Make WordPress Core

Changeset 40788


Ignore:
Timestamp:
05/19/17 03:52:07 (4 months 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/custom-header.php

    r39123 r40788  
    4343    /** 
    4444     * Used to trigger a success message when settings updated and set to true. 
    45      * 
     45     * 
    4646     * @since 3.0.0 
    4747     * @access private 
     
    10981098     * Calculate width and height based on what the currently selected theme supports. 
    10991099     * 
     1100     * @since 3.9.0 
     1101     * 
    11001102     * @param array $dimensions 
    11011103     * @return array dst_height and dst_width of header image. 
     
    11481150     * Create an attachment 'object'. 
    11491151     * 
     1152     * @since 3.9.0 
     1153     * 
    11501154     * @param string $cropped              Cropped image URL. 
    11511155     * @param int    $parent_attachment_id Attachment ID of parent image. 
    1152      * 
    11531156     * @return array Attachment object. 
    11541157     */ 
     
    11751178     * Insert an attachment and its metadata. 
    11761179     * 
     1180     * @since 3.9.0 
     1181     * 
    11771182     * @param array  $object  Attachment object. 
    11781183     * @param string $cropped Cropped image URL. 
    1179      * 
    11801184     * @return int Attachment ID. 
    11811185     */ 
     
    12001204     * Gets attachment uploaded by Media Manager, crops it, then saves it as a 
    12011205     * new object. Returns JSON-encoded object details. 
     1206     * 
     1207     * @since 3.9.0 
    12021208     */ 
    12031209    public function ajax_header_crop() { 
     
    12581264     * Triggered when the user tries adds a new header image from the 
    12591265     * Media Manager, even if s/he doesn't save that change. 
     1266     * 
     1267     * @since 3.9.0 
    12601268     */ 
    12611269    public function ajax_header_add() { 
     
    12841292     * Triggered when the user clicks the overlay "X" button next to each image 
    12851293     * choice in the Customizer's Header tool. 
     1294     * 
     1295     * @since 3.9.0 
    12861296     */ 
    12871297    public function ajax_header_remove() { 
     
    13051315 
    13061316    /** 
    1307      * 
    1308      * @param WP_Customize_Manager $wp_customize 
     1317     * Updates the last-used postmeta on a header image attachment after saving a new header image via the Customizer. 
     1318     * 
     1319     * @since 3.9.0 
     1320     * 
     1321     * @param WP_Customize_Manager $wp_customize Customize manager. 
    13091322     */ 
    13101323    public function customize_set_last_used( $wp_customize ) { 
     
    13211334 
    13221335    /** 
    1323      * 
    1324      * @return array 
     1336     * Gets the details of default header images if defined. 
     1337     * 
     1338     * @since 3.9.0 
     1339     * 
     1340     * @return array Default header images. 
    13251341     */ 
    13261342    public function get_default_header_images() { 
     
    13611377 
    13621378    /** 
    1363      * 
    1364      * @return array 
     1379     * Gets the previously uploaded header images. 
     1380     * 
     1381     * @since 3.9.0 
     1382     * 
     1383     * @return array Uploaded header images. 
    13651384     */ 
    13661385    public function get_uploaded_header_images() { 
Note: See TracChangeset for help on using the changeset viewer.