Make WordPress Core

Changeset 54267


Ignore:
Timestamp:
09/20/2022 08:30:03 PM (20 months ago)
Author:
johnbillion
Message:

Docs: Various improvements and corrections to inline docs.

See #55646

Location:
trunk/src
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/template.php

    r54247 r54267  
    16501650 *                           in which to show the box. Default 'default'.
    16511651 * @param array    $args {
    1652  *     Optional. Extra arguments used when outputting the field.
     1652 *     Optional. Extra arguments that get passed to the callback function.
    16531653 *
    16541654 *     @type string $label_for When supplied, the setting title will be wrapped
  • trunk/src/wp-includes/cron.php

    r54210 r54267  
    378378
    379379    /**
    380      * Filter to preflight or hijack rescheduling of events.
     380     * Filter to preflight or hijack rescheduling of a recurring event.
    381381     *
    382382     * Returning a non-null value will short-circuit the normal rescheduling
     
    393393     *     An object containing an event's data.
    394394     *
    395      *     @type string       $hook      Action hook to execute when the event is run.
    396      *     @type int          $timestamp Unix timestamp (UTC) for when to next run the event.
    397      *     @type string|false $schedule  How often the event should subsequently recur.
    398      *     @type array        $args      Array containing each separate argument to pass to the hook's callback function.
    399      *     @type int          $interval  The interval time in seconds for the schedule. Only present for recurring events.
     395     *     @type string $hook      Action hook to execute when the event is run.
     396     *     @type int    $timestamp Unix timestamp (UTC) for when to next run the event.
     397     *     @type string $schedule  How often the event should subsequently recur.
     398     *     @type array  $args      Array containing each separate argument to pass to the hook's callback function.
     399     *     @type int    $interval  The interval time in seconds for the schedule.
    400400     * }
    401401     * @param bool               $wp_error Whether to return a WP_Error on failure.
  • trunk/src/wp-includes/functions.php

    r54240 r54267  
    14971497         * @see wp_get_nocache_headers()
    14981498         *
    1499          * @param array $headers {
    1500          *     Header names and field values.
    1501          *
    1502          *     @type string $Expires       Expires header.
    1503          *     @type string $Cache-Control Cache-Control header.
    1504          * }
     1499         * @param array $headers Header names and field values.
    15051500         */
    15061501        $headers = (array) apply_filters( 'nocache_headers', $headers );
  • trunk/src/wp-includes/general-template.php

    r54224 r54267  
    43394339 *
    43404340 * @param string $doctype Optional. The type of HTML document. Accepts 'xhtml' or 'html'. Default 'html'.
     4341 * @return string A space-separated list of language attributes.
    43414342 */
    43424343function get_language_attributes( $doctype = 'html' ) {
  • trunk/src/wp-includes/option.php

    r54145 r54267  
    343343 *
    344344 * @since 3.0.0
    345  * @since 6.1.0 Uses update_meta_cache
     345 * @since 6.1.0 Now uses update_meta_cache().
    346346 *
    347347 * @param int $network_id Optional site ID for which to query the options. Defaults to the current site.
     
    18071807     * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    18081808     *
    1809      * Returning a truthy value from the filter will effectively short-circuit retrieval
    1810      * and return the passed value instead.
     1809     * Returning a value other than boolean false will short-circuit retrieval and
     1810     * return that value instead.
    18111811     *
    18121812     * @since 2.9.0
  • trunk/src/wp-includes/post.php

    r54255 r54267  
    79797979 *
    79807980 * @param string $type
    7981  * @return mixed
     7981 * @return string[] An array of MIME types.
    79827982 */
    79837983function get_available_post_mime_types( $type = 'attachment' ) {
  • trunk/src/wp-includes/script-loader.php

    r54254 r54267  
    170170 *
    171171 * @param WP_Scripts $scripts WP_Scripts object.
    172  * @param array      $tests   Features to detect.
     172 * @param string[]   $tests   Features to detect.
    173173 * @return string Conditional polyfill inline script.
    174174 */
     
    17461746 * @since 2.3.1
    17471747 *
    1748  * @param array $js_array JavaScript scripts array
    1749  * @return array Reordered array, if needed.
     1748 * @param string[] $js_array JavaScript scripts array
     1749 * @return string[] Reordered array, if needed.
    17501750 */
    17511751function wp_prototype_before_jquery( $js_array ) {
Note: See TracChangeset for help on using the changeset viewer.