Make WordPress Core

Changeset 54470


Ignore:
Timestamp:
10/11/2022 09:00:33 AM (22 months ago)
Author:
johnbillion
Message:

Docs: Various improvements to inline docblocks.

See #55646

Location:
trunk/src/wp-includes
Files:
6 edited

Legend:

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

    r54445 r54470  
    11391139
    11401140/**
    1141  * Prints a template-part.
    1142  *
    1143  * @since 5.9.0
    1144  *
    1145  * @param string $part The template-part to print. Use "header" or "footer".
     1141 * Prints a block template part.
     1142 *
     1143 * @since 5.9.0
     1144 *
     1145 * @param string $part The block template part to print. Use "header" or "footer".
    11461146 */
    11471147function block_template_part( $part ) {
     
    11541154
    11551155/**
    1156  * Prints the header template-part.
     1156 * Prints the header block template part.
    11571157 *
    11581158 * @since 5.9.0
     
    11631163
    11641164/**
    1165  * Prints the footer template-part.
     1165 * Prints the footer block template part.
    11661166 *
    11671167 * @since 5.9.0
  • trunk/src/wp-includes/class-wp-dependencies.php

    r54254 r54470  
    240240     *
    241241     * @param string           $handle Name of the item. Should be unique.
    242      * @param string|bool      $src    Full URL of the item, or path of the item relative
     242     * @param string|false     $src    Full URL of the item, or path of the item relative
    243243     *                                 to the WordPress root directory. If source is set to false,
    244244     *                                 item is an alias of other items it depends on.
  • trunk/src/wp-includes/cron.php

    r54267 r54470  
    99 * Schedules an event to run only once.
    1010 *
    11  * Schedules a hook which will be triggered by WordPress at the specified time.
     11 * Schedules a hook which will be triggered by WordPress at the specified UTC time.
    1212 * The action will trigger when someone visits your WordPress site if the scheduled
    1313 * time has passed.
     
    207207 * Valid values for the recurrence are 'hourly', 'daily', and 'twicedaily'. These can
    208208 * be extended using the {@see 'cron_schedules'} filter in wp_get_schedules().
    209  *
    210  * Note that scheduling an event to occur within 10 minutes of an existing event
    211  * with the same action hook will be ignored unless you pass unique `$args` values
    212  * for each scheduled event.
    213209 *
    214210 * Use wp_next_scheduled() to prevent duplicate events.
     
    318314 * Reschedules a recurring event.
    319315 *
    320  * Mainly for internal use, this takes the time stamp of a previously run
     316 * Mainly for internal use, this takes the UTC timestamp of a previously run
    321317 * recurring event and reschedules it for its next run.
    322318 *
     
    384380     *
    385381     * For plugins replacing wp-cron, return true if the event was successfully
    386      * rescheduled, false if not.
     382     * rescheduled, false or a WP_Error if not.
    387383     *
    388384     * @since 5.1.0
     
    481477     *
    482478     * For plugins replacing wp-cron, return true if the event was successfully
    483      * unscheduled, false if not.
     479     * unscheduled, false or a WP_Error if not.
    484480     *
    485481     * @since 5.1.0
     
    562558     * For plugins replacing wp-cron, return the number of events successfully
    563559     * unscheduled (zero if no events were registered with the hook) or false
    564      * if unscheduling one or more events fails.
     560     * or a WP_Error if unscheduling one or more events fails.
    565561     *
    566562     * @since 5.1.0
  • trunk/src/wp-includes/functions.wp-scripts.php

    r54351 r54470  
    160160 *
    161161 * @param string           $handle    Name of the script. Should be unique.
    162  * @param string|bool      $src       Full URL of the script, or path of the script relative to the WordPress root directory.
     162 * @param string|false     $src       Full URL of the script, or path of the script relative to the WordPress root directory.
    163163 *                                    If source is set to false, script is an alias of other scripts it depends on.
    164164 * @param string[]         $deps      Optional. An array of registered script handles this script depends on. Default empty array.
  • trunk/src/wp-includes/functions.wp-styles.php

    r52216 r54470  
    115115 *
    116116 * @param string           $handle Name of the stylesheet. Should be unique.
    117  * @param string|bool      $src    Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
     117 * @param string|false     $src    Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
    118118 *                                 If source is set to false, stylesheet is an alias of other stylesheets it depends on.
    119119 * @param string[]         $deps   Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
  • trunk/src/wp-includes/general-template.php

    r54286 r54470  
    44644464 *     @type string $after_page_number  A string to append after the page number. Default empty.
    44654465 * }
    4466  * @return string|array|void String of page links or array of page links, depending on 'type' argument.
    4467  *                           Void if total number of pages is less than 2.
     4466 * @return string|string[]|void String of page links or array of page links, depending on 'type' argument.
     4467 *                              Void if total number of pages is less than 2.
    44684468 */
    44694469function paginate_links( $args = '' ) {
Note: See TracChangeset for help on using the changeset viewer.