Make WordPress Core


Ignore:
Timestamp:
07/23/2020 09:09:04 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Another pass at some inline docs fixes mostly made by PHPCBF.

See #49572, #50744

File:
1 edited

Legend:

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

    r48576 r48590  
    10631063 * @param int   $comment_ID Comment ID.
    10641064 * @param array $args {
    1065  *      Array of optional arguments.
    1066  *      @type string     $type      Limit paginated comments to those matching a given type.
    1067  *                                  Accepts 'comment', 'trackback', 'pingback', 'pings'
    1068  *                                  (trackbacks and pingbacks), or 'all'. Default 'all'.
    1069  *      @type int        $per_page  Per-page count to use when calculating pagination.
    1070  *                                  Defaults to the value of the 'comments_per_page' option.
    1071  *      @type int|string $max_depth If greater than 1, comment page will be determined
    1072  *                                  for the top-level parent `$comment_ID`.
    1073  *                                  Defaults to the value of the 'thread_comments_depth' option.
     1065 *     Array of optional arguments.
     1066 *
     1067 *     @type string     $type      Limit paginated comments to those matching a given type.
     1068 *                                 Accepts 'comment', 'trackback', 'pingback', 'pings'
     1069 *                                 (trackbacks and pingbacks), or 'all'. Default 'all'.
     1070 *     @type int        $per_page  Per-page count to use when calculating pagination.
     1071 *                                 Defaults to the value of the 'comments_per_page' option.
     1072 *     @type int|string $max_depth If greater than 1, comment page will be determined
     1073 *                                 for the top-level parent `$comment_ID`.
     1074 *                                 Defaults to the value of the 'thread_comments_depth' option.
    10741075 * } *
    10751076 * @return int|null Comment page number or null on error.
     
    21152116 * @since 2.1.0
    21162117 *
    2117  * @param bool $block Whether plugin has already blocked comment.
    2118  * @param int $time_lastcomment Timestamp for last comment.
    2119  * @param int $time_newcomment Timestamp for new comment.
     2118 * @param bool $block            Whether plugin has already blocked comment.
     2119 * @param int  $time_lastcomment Timestamp for last comment.
     2120 * @param int  $time_newcomment Timestamp for new comment.
    21202121 * @return bool Whether comment should be blocked.
    21212122 */
     
    21732174 *                                        'REMOTE_ADDR' in the `$_SERVER` superglobal sent in the original request.
    21742175 * }
    2175  * @param bool $wp_error Should errors be returned as WP_Error objects instead of
    2176  *                       executing wp_die()? Default false.
     2176 * @param bool  $wp_error Should errors be returned as WP_Error objects instead of
     2177 *                        executing wp_die()? Default false.
    21772178 * @return int|false|WP_Error The ID of the comment on success, false or WP_Error on failure.
    21782179 */
     
    27112712 * @since 1.5.0
    27122713 *
    2713  * @param string $url URL to ping.
    2714  * @param int $deprecated Not Used.
     2714 * @param string $url        URL to ping.
     2715 * @param int    $deprecated Not Used.
    27152716 * @return string|false String containing URI on success, false on failure.
    27162717 */
     
    29412942 * @since 4.7.0 `$post_id` can be a WP_Post object.
    29422943 *
    2943  * @param string $content Post content to check for links. If empty will retrieve from post.
     2944 * @param string      $content Post content to check for links. If empty will retrieve from post.
    29442945 * @param int|WP_Post $post_id Post Object or ID.
    29452946 */
     
    30683069 *
    30693070 * @param string $trackback_url URL to send trackbacks.
    3070  * @param string $title Title of post.
    3071  * @param string $excerpt Excerpt of post.
    3072  * @param int $ID Post ID.
     3071 * @param string $title         Title of post.
     3072 * @param string $excerpt       Excerpt of post.
     3073 * @param int    $ID            Post ID.
    30733074 * @return int|false|void Database query from update.
    30743075 */
     
    32873288 * @access private
    32883289 *
    3289  * @param bool $open Comments open or closed
    3290  * @param int $post_id Post ID
     3290 * @param bool $open    Comments open or closed.
     3291 * @param int  $post_id Post ID.
    32913292 * @return bool $open
    32923293 */
Note: See TracChangeset for help on using the changeset viewer.