WordPress.org
Get WordPress

Make WordPress Core

Changeset 48110


Ignore:
Timestamp:
06/20/2020 12:57:00 PM (6 years ago)
Author:
SergeyBiryukov
Message:

Docs: Remove extra spaces from @param tags.

Per the documentation standards, @param tags should be aligned with each other, but not with the @return tag.

See #49572.

Location:
trunk/src
Files:
37 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/js/_enqueues/admin/inline-edit-post.js

    r48104 r48110  
    390390         * @since 2.7.0
    391391         *
    392          * @param  {int}    id The ID for the post that has been changed.
    393          * @return {boolean}    False, so the form does not submit when pressing
    394          *                      Enter on a focused field.
     392         * @param {int} id The ID for the post that has been changed.
     393         * @return {boolean} False, so the form does not submit when pressing
     394         *                   Enter on a focused field.
    395395         */
    396396        save : function(id) {
    … …  
    504504         * @memberof inlineEditPost
    505505         *
    506          * @param  {Object} o DOM row object to get the ID for.
    507          * @return {string}   The post ID extracted from the table row in the object.
     506         * @param {Object} o DOM row object to get the ID for.
     507         * @return {string} The post ID extracted from the table row in the object.
    508508         */
    509509        getId : function(o) {

  • trunk/src/js/_enqueues/lib/image-edit.js

    r48104 r48110  
    414414         * @memberof imageEdit
    415415         *
    416          * @param  {number} postid The post ID.
    417          * @param  {string} nonce  The nonce to verify the request.
    418          * @param  {string} action The action to perform on the image.
    419          *                          The possible actions are: "scale" and "restore".
     416         * @param {number} postid The post ID.
     417         * @param {string} nonce  The nonce to verify the request.
     418         * @param {string} action The action to perform on the image.
     419         *                        The possible actions are: "scale" and "restore".
    420420         *
    421421         * @return {boolean|void} Executes a post request that refreshes the page

  • trunk/src/js/_enqueues/lib/lists.js

    r46800 r48110  
    236236         * data[4] - unspam=1
    237237         *
    238          * @param  {HTMLElement} element The DOM element.
    239          * @param  {string}      type    The type of data to look for: 'list', 'add', 'delete', or 'dim'.
     238         * @param {HTMLElement} element The DOM element.
     239         * @param {string}      type    The type of data to look for: 'list', 'add', 'delete', or 'dim'.
    240240         * @return {Array} Extracted list item data.
    241241         */

  • trunk/src/js/_enqueues/lib/nav-menu.js

    r47294 r48110  
    430430                 * Shows or hides buttons based on the location of the menu item.
    431431                 *
    432                  * @param  {object} itemToRefresh The menu item that might need its advanced accessibility buttons refreshed
     432                 * @param {object} itemToRefresh The menu item that might need its advanced accessibility buttons refreshed
    433433                 */
    434434                refreshAdvancedAccessibilityOfItem : function( itemToRefresh ) {
    … …  
    12931293                /**
    12941294                 * Remove a menu item.
    1295                  * @param  {object} el The element to be removed as a jQuery object.
     1295                 *
     1296                 * @param {object} el The element to be removed as a jQuery object.
    12961297                 *
    12971298                 * @fires document#menu-removing-item Passes the element to be removed.

  • trunk/src/js/_enqueues/vendor/plupload/wp-plupload.js

    r47834 r48110  
    116116                 * @since 5.3.0
    117117                 *
    118                  * @param  {string}        message Error message.
    119                  * @param  {object}        data     Error data from Plupload.
    120                  * @param  {plupload.File} file     File that was uploaded.
     118                 * @param {string}        message Error message.
     119                 * @param {object}        data    Error data from Plupload.
     120                 * @param {plupload.File} file    File that was uploaded.
    121121                 */
    122122                tryAgain = function( message, data, file ) {
    … …  
    204204                 * and display errors. @see wp.Uploader.errors.
    205205                 *
    206                  * @param  {string}        message Error message.
    207                  * @param  {object}        data     Error data from Plupload.
    208                  * @param  {plupload.File} file     File that was uploaded.
    209                  * @param  {string}        retry    Whether to try again to create image sub-sizes. Passing 'no-retry' will prevent it.
     206                 * @param {string}        message Error message.
     207                 * @param {object}        data    Error data from Plupload.
     208                 * @param {plupload.File} file    File that was uploaded.
     209                 * @param {string}        retry   Whether to try again to create image sub-sizes. Passing 'no-retry' will prevent it.
    210210                 */
    211211                error = function( message, data, file, retry ) {

  • trunk/src/js/_enqueues/vendor/tinymce/plugins/wptextpattern/plugin.js

    r48106 r48110  
    5353         * Escapes characters for use in a Regular Expression.
    5454         *
    55          * @param  {String} string Characters to escape
     55         * @param {String} string Characters to escape
    5656         *
    57          * @return {String}        Escaped characters
     57         * @return {String} Escaped characters
    5858         */
    5959        function escapeRegExp( string ) {

  • trunk/src/js/_enqueues/wp/api.js

    r48106 r48110  
    361361                         * Build a helper function to retrieve related model.
    362362                         *
    363                          * @param  {string} parentModel      The parent model.
    364                          * @param  {int}    modelId          The model ID if the object to request
    365                          * @param  {string} modelName        The model name to use when constructing the model.
    366                          * @param  {string} embedSourcePoint Where to check the embedds object for _embed data.
    367                          * @param  {string} embedCheckField  Which model field to check to see if the model has data.
     363                         * @param {string} parentModel      The parent model.
     364                         * @param {int}    modelId          The model ID if the object to request
     365                         * @param {string} modelName        The model name to use when constructing the model.
     366                         * @param {string} embedSourcePoint Where to check the embedds object for _embed data.
     367                         * @param {string} embedCheckField  Which model field to check to see if the model has data.
    368368                         *
    369369                         * @return {Deferred.promise}        A promise which resolves to the constructed model.
    … …  
    415415                         * Build a helper to retrieve a collection.
    416416                         *
    417                          * @param  {string} parentModel      The parent model.
    418                          * @param  {string} collectionName   The name to use when constructing the collection.
    419                          * @param  {string} embedSourcePoint Where to check the embedds object for _embed data.
    420                          * @param  {string} embedIndex       An addiitonal optional index for the _embed data.
     417                         * @param {string} parentModel      The parent model.
     418                         * @param {string} collectionName   The name to use when constructing the collection.
     419                         * @param {string} embedSourcePoint Where to check the embedds object for _embed data.
     420                         * @param {string} embedIndex       An addiitonal optional index for the _embed data.
    421421                         *
    422                          * @return {Deferred.promise}        A promise which resolves to the constructed collection.
     422                         * @return {Deferred.promise} A promise which resolves to the constructed collection.
    423423                         */
    424424                        buildCollectionGetter = function( parentModel, collectionName, embedSourcePoint, embedIndex ) {

  • trunk/src/js/_enqueues/wp/backbone.js

    r43347 r48110  
    2424         * @class
    2525         *
    26          * @param  {wp.Backbone.View} view  The main view.
    27          * @param  {Array|Object}     views The subviews for the main view.
     26         * @param {wp.Backbone.View} view  The main view.
     27         * @param {Array|Object}     views The subviews for the main view.
    2828         */
    2929        wp.Backbone.Subviews = function( view, views ) {

  • trunk/src/js/_enqueues/wp/customize/base.js

    r47122 r48110  
    1818         * class properties to be extended.
    1919         *
    20          * @param  object parent      Parent class constructor to inherit from.
    21          * @param  object protoProps  Properties to apply to the prototype for use as class instance properties.
    22          * @param  object staticProps Properties to apply directly to the class constructor.
    23          * @return child              The subclassed constructor.
     20         * @param object parent      Parent class constructor to inherit from.
     21         * @param object protoProps  Properties to apply to the prototype for use as class instance properties.
     22         * @param object staticProps Properties to apply directly to the class constructor.
     23         * @return child The subclassed constructor.
    2424         */
    2525        inherits = function( parent, protoProps, staticProps ) {
    … …  
    109109         * Creates a subclass of the class.
    110110         *
    111          * @param  object protoProps  Properties to apply to the prototype.
    112          * @param  object staticProps Properties to apply directly to the class.
    113          * @return child              The subclass.
     111         * @param object protoProps  Properties to apply to the prototype.
     112         * @param object staticProps Properties to apply directly to the class.
     113         * @return child The subclass.
    114114         */
    115115        api.Class.extend = function( protoProps, classProps ) {
    … …  
    355355                 * @see {api.Values.when}
    356356                 *
    357                  * @param  {string}  id ID of the item.
    358                  * @param  {...}         Zero or more IDs of items to wait for and a callback
    359                  *                       function to invoke when they're available. Optional.
    360                  * @return {mixed}    The item instance if only one ID was supplied.
    361                  *                    A Deferred Promise object if a callback function is supplied.
     357                 * @param {string} id ID of the item.
     358                 * @param {...}       Zero or more IDs of items to wait for and a callback
     359                 *                    function to invoke when they're available. Optional.
     360                 * @return {mixed} The item instance if only one ID was supplied.
     361                 *                 A Deferred Promise object if a callback function is supplied.
    362362                 */
    363363                instance: function( id ) {
    … …  
    372372                 * Get the instance of an item.
    373373                 *
    374                  * @param  {string} id The ID of the item.
    375                  * @return {[type]}    [description]
     374                 * @param {string} id The ID of the item.
     375                 * @return {[type]} [description]
    376376                 */
    377377                value: function( id ) {
    … …  
    382382                 * Whether the collection has an item with the given ID.
    383383                 *
    384                  * @param  {string} id The ID of the item to look for.
     384                 * @param {string} id The ID of the item to look for.
    385385                 * @return {Boolean}
    386386                 */
    … …  
    436436                 * and store it in the collection.
    437437                 *
    438                  * @param  {string} id    The ID of the item.
    439                  * @param  {mixed}  value Any extra arguments are passed into the item's initialize method.
    440                  * @return {mixed}  The new item's instance.
     438                 * @param {string} id    The ID of the item.
     439                 * @param {mixed}  value Any extra arguments are passed into the item's initialize method.
     440                 * @return {mixed} The new item's instance.
    441441                 */
    442442                create: function( id ) {
    … …  
    447447                 * Iterate over all items in the collection invoking the provided callback.
    448448                 *
    449                  * @param  {Function} callback Function to invoke.
    450                  * @param  {object}   context  Object context to invoke the function with. Optional.
     449                 * @param {Function} callback Function to invoke.
     450                 * @param {object}   context  Object context to invoke the function with. Optional.
    451451                 */
    452452                each: function( callback, context ) {
    … …  
    461461                 * Remove an item from the collection.
    462462                 *
    463                  * @param  {string} id The ID of the item to remove.
     463                 * @param {string} id The ID of the item to remove.
    464464                 */
    465465                remove: function( id ) {
    … …  
    671671                 * Create a new Value.
    672672                 *
    673                  * @param  {string} key     Unique identifier.
    674                  * @param  {mixed}  initial Initial value.
    675                  * @param  {mixed}  options Options hash. Optional.
    676                  * @return {Value}          Class instance of the Value.
     673                 * @param {string} key     Unique identifier.
     674                 * @param {mixed}  initial Initial value.
     675                 * @param {mixed}  options Options hash. Optional.
     676                 * @return {Value} Class instance of the Value.
    677677                 */
    678678                add: function( key, initial, options ) {
    … …  
    683683                 * Initialize Messenger.
    684684                 *
    685                  * @param  {object} params - Parameters to configure the messenger.
    686                  *         {string} params.url - The URL to communicate with.
    687                  *         {window} params.targetWindow - The window instance to communicate with. Default window.parent.
    688                  *         {string} params.channel - If provided, will send the channel with each message and only accept messages a matching channel.
    689                  * @param  {object} options - Extend any instance parameter or method with this object.
     685                 * @param {object} params - Parameters to configure the messenger.
     686                 *        {string} params.url          - The URL to communicate with.
     687                 *        {window} params.targetWindow - The window instance to communicate with. Default window.parent.
     688                 *        {string} params.channel      - If provided, will send the channel with each message and only accept messages a matching channel.
     689                 * @param {object} options - Extend any instance parameter or method with this object.
    690690                 */
    691691                initialize: function( params, options ) {
    … …  
    748748                 * Receive data from the other window.
    749749                 *
    750                  * @param  {jQuery.Event} event Event with embedded data.
     750                 * @param {jQuery.Event} event Event with embedded data.
    751751                 */
    752752                receive: function( event ) {
    … …  
    787787                 * Send data to the other window.
    788788                 *
    789                  * @param  {string} id   The event name.
    790                  * @param  {object} data Data.
     789                 * @param {string} id   The event name.
     790                 * @param {object} data Data.
    791791                 */
    792792                send: function( id, data ) {

  • trunk/src/js/_enqueues/wp/customize/loader.js

    r47122 r48110  
    107107                 * Open the Customizer overlay for a specific URL.
    108108                 *
    109                  * @param  string src URL to load in the Customizer.
     109                 * @param string src URL to load in the Customizer.
    110110                 */
    111111                open: function( src ) {

  • trunk/src/js/_enqueues/wp/customize/preview-widgets.js

    r48104 r48110  
    632632         *
    633633         * @since 3.9.0
    634          * @param  {string} widgetId ID of the widget.
     634         * @param {string} widgetId ID of the widget.
    635635         *
    636636         * @return {void}

  • trunk/src/js/_enqueues/wp/media/models.js

    r47122 r48110  
    1818 * @namespace
    1919 *
    20  * @param  {object} attributes The properties passed to the main media controller.
     20 * @param {object} attributes The properties passed to the main media controller.
    2121 * @return {wp.media.view.MediaFrame} A media workflow.
    2222 */
    … …  
    8787 * Used to order models within a collection - @see wp.media.model.Attachments.comparator().
    8888 *
    89  * @param  {mixed}  a  The primary parameter to compare.
    90  * @param  {mixed}  b  The primary parameter to compare.
    91  * @param  {string} ac The fallback parameter to compare, a's cid.
    92  * @param  {string} bc The fallback parameter to compare, b's cid.
    93  * @return {number}    -1: a should come before b.
    94  *                      0: a and b are of the same rank.
    95  *                      1: b should come before a.
     89 * @param {mixed}  a  The primary parameter to compare.
     90 * @param {mixed}  b  The primary parameter to compare.
     91 * @param {string} ac The fallback parameter to compare, a's cid.
     92 * @param {string} bc The fallback parameter to compare, b's cid.
     93 * @return {number} -1: a should come before b.
     94 *                   0: a and b are of the same rank.
     95 *                   1: b should come before a.
    9696 */
    9797media.compare = function( a, b, ac, bc ) {

  • trunk/src/js/_enqueues/wp/util.js

    r47122 r48110  
    1717         * Fetch a JavaScript template for an id, and return a templating function for it.
    1818         *
    19          * @param  {string} id  A string that corresponds to a DOM element with an id prefixed with "tmpl-".
    20          *                       For example, "attachment" maps to "tmpl-attachment".
    21          * @return {function}    A function that lazily-compiles the template requested.
     19         * @param {string} id A string that corresponds to a DOM element with an id prefixed with "tmpl-".
     20         *                    For example, "attachment" maps to "tmpl-attachment".
     21         * @return {function} A function that lazily-compiles the template requested.
    2222         */
    2323        wp.template = _.memoize(function ( id ) {
    … …  
    5757                 * Sends a POST request to WordPress.
    5858                 *
    59                  * @param  {(string|object)} action The slug of the action to fire in WordPress or options passed
    60                  *                                   to jQuery.ajax.
    61                  * @param  {object=}         data    Optional. The data to populate $_POST with.
    62                  * @return {$.promise}     A jQuery promise that represents the request,
    63                  *                         decorated with an abort() method.
     59                 * @param {(string|object)} action The slug of the action to fire in WordPress or options passed
     60                 *                                 to jQuery.ajax.
     61                 * @param {object=}         data   Optional. The data to populate $_POST with.
     62                 * @return {$.promise} A jQuery promise that represents the request,
     63                 *                     decorated with an abort() method.
    6464                 */
    6565                post: function( action, data ) {
    … …  
    7474                 * Sends a POST request to WordPress.
    7575                 *
    76                  * @param  {(string|object)} action  The slug of the action to fire in WordPress or options passed
    77                  *                                   to jQuery.ajax.
    78                  * @param  {object=}         options Optional. The options passed to jQuery.ajax.
    79                  * @return {$.promise}      A jQuery promise that represents the request,
    80                  *                          decorated with an abort() method.
     76                 * @param {(string|object)} action  The slug of the action to fire in WordPress or options passed
     77                 *                                  to jQuery.ajax.
     78                 * @param {object=}         options Optional. The options passed to jQuery.ajax.
     79                 * @return {$.promise} A jQuery promise that represents the request,
     80                 *                     decorated with an abort() method.
    8181                 */
    8282                send: function( action, options ) {

  • trunk/src/js/media/models/query.js

    r47122 r48110  
    9595         * Fetch more attachments from the server for the collection.
    9696         *
    97          * @param   {object} [options={}]
     97         * @param {object} [options={}]
    9898         * @return {Promise}
    9999         */

  • trunk/src/js/media/views/attachment.js

    r47122 r48110  
    502502         * remove it.
    503503         *
    504          * @param  {[type]} event [description]
    505          * @return {[type]}       [description]
     504         * @param {[type]} event [description]
     505         * @return {[type]} [description]
    506506         */
    507507        checkClickHandler: function ( event ) {

  • trunk/src/js/media/views/frame.js

    r46800 r48110  
    153153         * Check if a mode is enabled on the frame.
    154154         *
    155          * @param  string mode Mode ID.
     155         * @param string mode Mode ID.
    156156         * @return bool
    157157         */

  • trunk/src/js/media/views/uploader/editor.js

    r46800 r48110  
    130130         * and upload the file immediately.
    131131         *
    132          * @param  {jQuery.Event} event The 'drop' event.
     132         * @param {jQuery.Event} event The 'drop' event.
    133133         */
    134134        drop: function( event ) {

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

    r47808 r48110  
    14911491         * @since 4.9.0
    14921492         *
    1493          * @param  array $object A crop attachment object.
     1493         * @param array $object A crop attachment object.
    14941494         * @return int|false An attachment ID if one exists. False if none.
    14951495         */

  • trunk/src/wp-admin/includes/class-wp-community-events.php

    r47550 r48110  
    301301         * @since 4.8.0
    302302         *
    303          * @param  array $location Should contain 'latitude' and 'longitude' indexes.
     303         * @param array $location Should contain 'latitude' and 'longitude' indexes.
    304304         * @return bool|string false on failure, or a string on success.
    305305         */
    … …  
    362362         * @since 4.8.0
    363363         *
    364          * @param  array $response_body The response which contains the events.
     364         * @param array $response_body The response which contains the events.
    365365         * @return array The response with dates and times formatted.
    366366         */
    … …  
    437437         * @since 4.9.7 Stick a WordCamp to the final list.
    438438         *
    439          * @param  array $response_body The response body which contains the events.
     439         * @param array $response_body The response body which contains the events.
    440440         * @return array The response body with events trimmed.
    441441         */

  • trunk/src/wp-admin/includes/class-wp-upgrader.php

    r47848 r48110  
    347347         * @access protected
    348348         *
    349          * @param  array  $nested_files  Array of files as returned by WP_Filesystem::dirlist()
    350          * @param  string $path          Relative path to prepend to child nodes. Optional.
     349         * @param array  $nested_files Array of files as returned by WP_Filesystem::dirlist().
     350         * @param string $path         Relative path to prepend to child nodes. Optional.
    351351         * @return array A flattened array of the $nested_files specified.
    352352         */

  • trunk/src/wp-admin/includes/plugin-install.php

    r48059 r48110  
    421421 * @since 3.0.0
    422422 *
    423  * @param  array|object $api  Data about the plugin retrieved from the API.
    424  * @param  bool         $loop Optional. Disable further loops. Default false.
     423 * @param array|object $api  Data about the plugin retrieved from the API.
     424 * @param bool         $loop Optional. Disable further loops. Default false.
    425425 * @return array {
    426426 *     Plugin installation status data.

  • trunk/src/wp-includes/class-wp-block-type.php

    r47908 r48110  
    189189         * @since 5.0.0
    190190         *
    191          * @param  array $attributes Original block attributes.
    192          * @return array             Prepared block attributes.
     191         * @param array $attributes Original block attributes.
     192         * @return array Prepared block attributes.
    193193         */
    194194        public function prepare_attributes_for_render( $attributes ) {

  • trunk/src/wp-includes/class-wp-customize-widgets.php

    r48109 r48110  
    11011101         * @since 4.2.0
    11021102         *
    1103          * @param  array $nonces Array of nonces.
     1103         * @param array $nonces Array of nonces.
    11041104         * @return array Array of nonces.
    11051105         */
    … …  
    13891389         * @global array $wp_registered_widget_controls
    13901390         *
    1391          * @param  string $widget_id Widget ID.
     1391         * @param string $widget_id Widget ID.
    13921392         * @return array|WP_Error Array containing the updated widget information.
    13931393         *                        A WP_Error object, otherwise.

  • trunk/src/wp-includes/class-wp-date-query.php

    r48102 r48110  
    241241         * @since 4.1.0
    242242         *
    243          * @param  array $query Query clause.
     243         * @param array $query Query clause.
    244244         * @return bool True if this is a first-order clause.
    245245         */
    … …  
    276276         * @since 4.1.0
    277277         *
    278          * @param  array $date_query The date_query array.
     278         * @param array $date_query The date_query array.
    279279         * @return bool  True if all values in the query are valid, false if one or more fail.
    280280         */
    … …  
    678678         * @since 3.7.0
    679679         *
    680          * @param  array $query Date query arguments.
     680         * @param array $query Date query arguments.
    681681         * @return array {
    682682         *     Array containing JOIN and WHERE SQL clauses to append to the main query.
    … …  
    695695         * @since 4.1.0
    696696         *
    697          * @param  array $query        Date query clause.
    698          * @param  array $parent_query Parent query of the current date query.
     697         * @param array $query        Date query clause.
     698         * @param array $parent_query Parent query of the current date query.
    699699         * @return array {
    700700         *     Array containing JOIN and WHERE SQL clauses to append to the main query.

  • trunk/src/wp-includes/class-wp-image-editor-gd.php

    r47122 r48110  
    147147         * @since 3.5.0
    148148         *
    149          * @param  int|null $max_w Image width.
    150          * @param  int|null $max_h Image height.
    151          * @param  bool     $crop
     149         * @param int|null $max_w Image width.
     150         * @param int|null $max_h Image height.
     151         * @param bool     $crop
    152152         * @return true|WP_Error
    153153         */

  • trunk/src/wp-includes/class-wp-image-editor-imagick.php

    r48102 r48110  
    242242         * @since 3.5.0
    243243         *
    244          * @param  int|null $max_w Image width.
    245          * @param  int|null $max_h Image height.
    246          * @param  bool     $crop
     244         * @param int|null $max_w Image width.
     245         * @param int|null $max_h Image height.
     246         * @param bool     $crop
    247247         * @return bool|WP_Error
    248248         */

  • trunk/src/wp-includes/class-wp-image-editor.php

    r48100 r48110  
    9191         * @abstract
    9292         *
    93          * @param  int|null $max_w Image width.
    94          * @param  int|null $max_h Image height.
    95          * @param  bool     $crop
     93         * @param int|null $max_w Image width.
     94         * @param int|null $max_h Image height.
     95         * @param bool     $crop
    9696         * @return bool|WP_Error
    9797         */

  • trunk/src/wp-includes/class-wp-matchesmapregex.php

    r47122 r48110  
    8080         * preg_replace_callback hook
    8181         *
    82          * @param  array $matches preg_replace regexp matches
     82         * @param array $matches preg_replace regexp matches
    8383         * @return string
    8484         */

  • trunk/src/wp-includes/class-wp-meta-query.php

    r47808 r48110  
    781781         * @since 4.1.0
    782782         *
    783          * @param  array      $clause       Query clause.
    784          * @param  array      $parent_query Parent query of $clause.
    785          * @return string|bool Table alias if found, otherwise false.
     783         * @param array $clause       Query clause.
     784         * @param array $parent_query Parent query of $clause.
     785         * @return string|false Table alias if found, otherwise false.
    786786         */
    787787        protected function find_compatible_table_alias( $clause, $parent_query ) {

  • trunk/src/wp-includes/class-wp-tax-query.php

    r47808 r48110  
    498498         * @since 4.1.0
    499499         *
    500          * @param array       $clause       Query clause.
    501          * @param array       $parent_query Parent query of $clause.
     500         * @param array $clause       Query clause.
     501         * @param array $parent_query Parent query of $clause.
    502502         * @return string|false Table alias if found, otherwise false.
    503503         */

  • trunk/src/wp-includes/comment.php

    r48109 r48110  
    155155 * @since 4.1.0 Refactored to leverage WP_Comment_Query over a direct query.
    156156 *
    157  * @param  int   $post_id The ID of the post.
    158  * @param  array $args    Optional. See WP_Comment_Query::__construct() for information on accepted arguments.
     157 * @param int   $post_id The ID of the post.
     158 * @param array $args    Optional. See WP_Comment_Query::__construct() for information on accepted arguments.
    159159 * @return int|array The approved comments, or number of comments if `$count`
    160160 *                   argument is true.
    … …  
    35613561 * @since 4.9.6
    35623562 *
    3563  * @param  array $erasers An array of personal data erasers.
     3563 * @param array $erasers An array of personal data erasers.
    35643564 * @return array An array of personal data erasers.
    35653565 */
    … …  
    35783578 * @since 4.9.6
    35793579 *
    3580  * @param  string $email_address The comment author email address.
    3581  * @param  int    $page          Comment page.
     3580 * @param string $email_address The comment author email address.
     3581 * @param int    $page          Comment page.
    35823582 * @return array
    35833583 */

  • trunk/src/wp-includes/functions.php

    r48109 r48110  
    28332833                         * @since 3.0.0
    28342834                         *
    2835                          * @param  array $mime_to_ext Array of image mime types and their matching extensions.
     2835                         * @param array $mime_to_ext Array of image mime types and their matching extensions.
    28362836                         */
    28372837                        $mime_to_ext = apply_filters(
    … …  
    44184418 * @since 4.7.0
    44194419 *
    4420  * @param  array|string $list List of slugs.
     4420 * @param array|string $list List of slugs.
    44214421 * @return string[] Sanitized array of slugs.
    44224422 */
    … …  
    64046404 * @link https://www.php.net/manual/en/function.checkdate.php
    64056405 *
    6406  * @param  int    $month       Month number.
    6407  * @param  int    $day         Day number.
    6408  * @param  int    $year        Year number.
    6409  * @param  string $source_date The date to filter.
     6406 * @param int    $month       Month number.
     6407 * @param int    $day         Day number.
     6408 * @param int    $year        Year number.
     6409 * @param string $source_date The date to filter.
    64106410 * @return bool True if valid date, false if not valid date.
    64116411 */
    … …  
    70707070 * @since 4.9.6 Abstracted from `WP_Community_Events::get_unsafe_client_ip()`.
    70717071 *
    7072  * @param  string $ip_addr        The IPv4 or IPv6 address to be anonymized.
    7073  * @param  bool   $ipv6_fallback Optional. Whether to return the original IPv6 address if the needed functions
    7074  *                                to anonymize it are not present. Default false, return `::` (unspecified address).
     7072 * @param string $ip_addr       The IPv4 or IPv6 address to be anonymized.
     7073 * @param bool   $ipv6_fallback Optional. Whether to return the original IPv6 address if the needed functions
     7074 *                              to anonymize it are not present. Default false, return `::` (unspecified address).
    70757075 * @return string  The anonymized IP address.
    70767076 */
    … …  
    71407140 * @since 4.9.6
    71417141 *
    7142  * @param  string $type The type of data to be anonymized.
    7143  * @param  string $data Optional The data to be anonymized.
     7142 * @param string $type The type of data to be anonymized.
     7143 * @param string $data Optional The data to be anonymized.
    71447144 * @return string The anonymous data for the requested type.
    71457145 */

  • trunk/src/wp-includes/general-template.php

    r48100 r48110  
    24162416 * @since 3.0.0
    24172417 *
    2418  * @param  string      $format Optional. PHP date format defaults to the date_format option if not specified.
    2419  * @param  int|WP_Post $post   Optional. Post ID or WP_Post object. Default current post.
     2418 * @param string      $format Optional. PHP date format defaults to the date_format option if not specified.
     2419 * @param int|WP_Post $post   Optional. Post ID or WP_Post object. Default current post.
    24202420 * @return string|false Date the current post was written. False on failure.
    24212421 */

  • trunk/src/wp-includes/link-template.php

    r48104 r48110  
    31453145 * @since 3.0.0
    31463146 *
    3147  * @param  string      $path   Optional. Path relative to the home URL. Default empty.
    3148  * @param  string|null $scheme Optional. Scheme to give the home URL context. Accepts
    3149  *                             'http', 'https', 'relative', 'rest', or null. Default null.
     3147 * @param string      $path   Optional. Path relative to the home URL. Default empty.
     3148 * @param string|null $scheme Optional. Scheme to give the home URL context. Accepts
     3149 *                            'http', 'https', 'relative', 'rest', or null. Default null.
    31503150 * @return string Home URL link with optional path appended.
    31513151 */
    … …  
    31653165 * @global string $pagenow
    31663166 *
    3167  * @param  int         $blog_id Optional. Site ID. Default null (current site).
    3168  * @param  string      $path    Optional. Path relative to the home URL. Default empty.
    3169  * @param  string|null $scheme  Optional. Scheme to give the home URL context. Accepts
    3170  *                              'http', 'https', 'relative', 'rest', or null. Default null.
     3167 * @param int         $blog_id Optional. Site ID. Default null (current site).
     3168 * @param string      $path    Optional. Path relative to the home URL. Default empty.
     3169 * @param string|null $scheme  Optional. Scheme to give the home URL context. Accepts
     3170 *                             'http', 'https', 'relative', 'rest', or null. Default null.
    31713171 * @return string Home URL link with optional path appended.
    31723172 */
    … …  
    33843384 * @since 2.6.0
    33853385 *
    3386  * @param  string $path   Optional. Extra path appended to the end of the URL, including
    3387  *                        the relative directory if $plugin is supplied. Default empty.
    3388  * @param  string $plugin Optional. A full path to a file inside a plugin or mu-plugin.
    3389  *                        The URL will be relative to its directory. Default empty.
    3390  *                        Typically this is done by passing `__FILE__` as the argument.
     3386 * @param string $path   Optional. Extra path appended to the end of the URL, including
     3387 *                       the relative directory if $plugin is supplied. Default empty.
     3388 * @param string $plugin Optional. A full path to a file inside a plugin or mu-plugin.
     3389 *                       The URL will be relative to its directory. Default empty.
     3390 *                       Typically this is done by passing `__FILE__` as the argument.
    33913391 * @return string Plugins URL link with optional paths appended.
    33923392 */
    … …  
    34863486 * @since 3.0.0
    34873487 *
    3488  * @param  string $path   Optional. Path relative to the home URL. Default empty.
    3489  * @param  string $scheme Optional. Scheme to give the home URL context. Accepts
    3490  *                        'http', 'https', or 'relative'. Default null.
     3488 * @param string $path   Optional. Path relative to the home URL. Default empty.
     3489 * @param string $scheme Optional. Scheme to give the home URL context. Accepts
     3490 *                       'http', 'https', or 'relative'. Default null.
    34913491 * @return string Home URL link with optional path appended.
    34923492 */

  • trunk/src/wp-includes/media.php

    r48109 r48110  
    45424542 * @since 4.9.6
    45434543 *
    4544  * @param  string $email_address The attachment owner email address.
    4545  * @param  int    $page          Attachment page.
     4544 * @param string $email_address The attachment owner email address.
     4545 * @param int    $page          Attachment page.
    45464546 * @return array An array of personal data.
    45474547 */

  • trunk/src/wp-includes/ms-functions.php

    r48109 r48110  
    25782578 * @since 3.0.0
    25792579 *
    2580  * @param  int $size Upload size limit in bytes.
    2581  * @return int       Upload size limit in bytes.
     2580 * @param int $size Upload size limit in bytes.
     2581 * @return int Upload size limit in bytes.
    25822582 */
    25832583function upload_size_limit_filter( $size ) {

  • trunk/src/wp-includes/rest-api.php

    r48102 r48110  
    718718 * @since 5.3.0
    719719 *
    720  * @param  array $array1 The array with master keys to check.
    721  * @param  array $array2 An array to compare keys against.
     720 * @param array $array1 The array with master keys to check.
     721 * @param array $array2 An array to compare keys against.
    722722 * @return array An associative array containing all the entries of array1 which have keys
    723723 *               that are present in all arguments.
    … …  
    10631063 * @since 4.7.0
    10641064 *
    1065  * @param  mixed            $value
    1066  * @param  WP_REST_Request $request
    1067  * @param  string           $param
     1065 * @param mixed           $value
     1066 * @param WP_REST_Request $request
     1067 * @param string          $param
    10681068 * @return true|WP_Error
    10691069 */
    … …  
    10831083 * @since 4.7.0
    10841084 *
    1085  * @param  mixed            $value
    1086  * @param  WP_REST_Request $request
    1087  * @param  string           $param
     1085 * @param mixed           $value
     1086 * @param WP_REST_Request $request
     1087 * @param string          $param
    10881088 * @return mixed
    10891089 */
    … …  
    11061106 * @since 4.7.0
    11071107 *
    1108  * @param  mixed            $value
    1109  * @param  WP_REST_Request $request
    1110  * @param  string           $param
     1108 * @param mixed           $value
     1109 * @param WP_REST_Request $request
     1110 * @param string          $param
    11111111 * @return mixed
    11121112 */
    … …  
    11301130 * @since 4.7.0
    11311131 *
    1132  * @param  string $ip IP address.
     1132 * @param string $ip IP address.
    11331133 * @return string|false The valid IP address, otherwise false.
    11341134 */
    … …  
    16341634 * @since 5.0.0
    16351635 *
    1636  * @param  array  $memo Reduce accumulator.
    1637  * @param  string $path REST API path to preload.
    1638  * @return array        Modified reduce accumulator.
     1636 * @param array  $memo Reduce accumulator.
     1637 * @param string $path REST API path to preload.
     1638 * @return array Modified reduce accumulator.
    16391639 */
    16401640function rest_preload_api_request( $memo, $path ) {
Note: See TracChangeset for help on using the changeset viewer.