WordPress.org
Get WordPress

Make WordPress Core

Changeset 55882


Ignore:
Timestamp:
06/05/2023 09:33:49 PM (16 months ago)
Author:
audrasjb
Message:

Docs: Various docblock improvements in Custom Header Image related functions, as per docblocks standards.

See #57840.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-custom-image-header.php

    r55881 r55882  
    6767
    6868    /**
    69      * Set up the hooks for the Custom Header admin page.
     69     * Sets up the hooks for the Custom Header admin page.
    7070     *
    7171     * @since 2.1.0
    … …  
    147147
    148148    /**
    149      * Get the current step.
     149     * Gets the current step.
    150150     *
    151151     * @since 2.6.0
    … …  
    170170
    171171    /**
    172      * Set up the enqueue for the JavaScript files.
     172     * Sets up the enqueue for the JavaScript files.
    173173     *
    174174     * @since 2.1.0
    … …  
    189189
    190190    /**
    191      * Set up the enqueue for the CSS files
     191     * Sets up the enqueue for the CSS files.
    192192     *
    193193     * @since 2.7.0
    … …  
    204204
    205205    /**
    206      * Execute custom header modification.
     206     * Executes custom header modification.
    207207     *
    208208     * @since 2.6.0
    … …  
    263263
    264264    /**
    265      * Process the default headers
     265     * Processes the default headers.
    266266     *
    267267     * @since 3.0.0
    … …  
    300300
    301301    /**
    302      * Display UI for selecting one of several default headers.
    303      *
    304      * Show the random image option if this theme has multiple header images.
     302     * Displays UI for selecting one of several default headers.
     303     *
     304     * Shows the random image option if this theme has multiple header images.
    305305     * Random image option is on by default if no header has been set.
    306306     *
    … …  
    347347
    348348    /**
    349      * Execute JavaScript depending on step.
     349     * Executes JavaScript depending on step.
    350350     *
    351351     * @since 2.1.0
    … …  
    362362
    363363    /**
    364      * Display JavaScript based on Step 1 and 3.
     364     * Displays JavaScript based on Step 1 and 3.
    365365     *
    366366     * @since 2.6.0
    … …  
    423423
    424424    /**
    425      * Display JavaScript based on Step 2.
     425     * Displays JavaScript based on Step 2.
    426426     *
    427427     * @since 2.6.0
    … …  
    499499
    500500    /**
    501      * Display first step of custom header image page.
     501     * Displays first step of custom header image page.
    502502     *
    503503     * @since 2.1.0
    … …  
    813813
    814814    /**
    815      * Display second step of custom header image page.
     815     * Displays second step of custom header image page.
    816816     *
    817817     * @since 2.1.0
    … …  
    956956
    957957    /**
    958      * Upload the file to be cropped in the second step.
     958     * Uploads the file to be cropped in the second step.
    959959     *
    960960     * @since 3.4.0
    … …  
    997997
    998998    /**
    999      * Display third step of custom header image page.
     999     * Displays third step of custom header image page.
    10001000     *
    10011001     * @since 2.1.0
    … …  
    10931093
    10941094    /**
    1095      * Display last step of custom header image page.
     1095     * Displays last step of custom header image page.
    10961096     *
    10971097     * @since 2.1.0
    … …  
    11031103
    11041104    /**
    1105      * Display the page based on the current step.
     1105     * Displays the page based on the current step.
    11061106     *
    11071107     * @since 2.1.0
    … …  
    11481148
    11491149    /**
    1150      * Choose a header image, selected from existing uploaded and default headers,
    1151      * or provide an array of uploaded header data (either new, or from media library).
     1150     * Chooses a header image, selected from existing uploaded and default headers,
     1151     * or provides an array of uploaded header data (either new, or from media library).
    11521152     *
    11531153     * @since 3.4.0
    11541154     *
    11551155     * @param mixed $choice Which header image to select. Allows for values of 'random-default-image',
    1156      *  for randomly cycling among the default images; 'random-uploaded-image', for randomly cycling
    1157      *  among the uploaded images; the key of a default image registered for that theme; and
    1158      *  the key of an image uploaded for that theme (the attachment ID of the image).
    1159      *  Or an array of arguments: attachment_id, url, width, height. All are required.
     1156     *                      for randomly cycling among the default images; 'random-uploaded-image',
     1157     *                      for randomly cycling among the uploaded images; the key of a default image
     1158     *                      registered for that theme; and the key of an image uploaded for that theme
     1159     *                      (the attachment ID of the image). Or an array of arguments: attachment_id,
     1160     *                      url, width, height. All are required.
    11601161     */
    11611162    final public function set_header_image( $choice ) {
    … …  
    12101211
    12111212    /**
    1212      * Remove a header image.
     1213     * Removes a header image.
    12131214     *
    12141215     * @since 3.4.0
    … …  
    12191220
    12201221    /**
    1221      * Reset a header image to the default image for the theme.
     1222     * Resets a header image to the default image for the theme.
    12221223     *
    12231224     * This method does not do anything if the theme does not have a default header image.
    … …  
    12491250
    12501251    /**
    1251      * Calculate width and height based on what the currently selected theme supports.
     1252     * Calculates width and height based on what the currently selected theme supports.
    12521253     *
    12531254     * @since 3.9.0
    … …  
    13001301
    13011302    /**
    1302      * Create an attachment 'object'.
     1303     * Creates an attachment 'object'.
    13031304     *
    13041305     * @since 3.9.0
    … …  
    13291330
    13301331    /**
    1331      * Insert an attachment and its metadata.
     1332     * Inserts an attachment and its metadata.
    13321333     *
    13331334     * @since 3.9.0
    … …  
    15791580
    15801581    /**
    1581      * Get the ID of a previous crop from the same base image.
     1582     * Gets the ID of a previous crop from the same base image.
    15821583     *
    15831584     * @since 4.9.0
Note: See TracChangeset for help on using the changeset viewer.