Completed
Pull Request — master (#2)
by Stephen
13:19
created
src/wp-includes/class-wp-query.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -1374,7 +1374,7 @@  discard block
 block discarded – undo
1374 1374
 	 *
1375 1375
 	 * @since 3.7.0
1376 1376
 	 *
1377
-	 * @param array $terms Terms to check.
1377
+	 * @param string[] $terms Terms to check.
1378 1378
 	 * @return array Terms that are not stopwords.
1379 1379
 	 */
1380 1380
 	protected function parse_search_terms( $terms ) {
@@ -1629,7 +1629,7 @@  discard block
 block discarded – undo
1629 1629
 	 * @access public
1630 1630
 	 *
1631 1631
 	 * @param string $query_var Query variable key.
1632
-	 * @param mixed  $default   Optional. Value to return if the query variable is not set. Default empty.
1632
+	 * @param boolean  $default   Optional. Value to return if the query variable is not set. Default empty.
1633 1633
 	 * @return mixed Contents of the query variable.
1634 1634
 	 */
1635 1635
 	public function get( $query_var, $default = '' ) {
@@ -3380,7 +3380,7 @@  discard block
 block discarded – undo
3380 3380
 	 * @access public
3381 3381
 	 *
3382 3382
 	 * @param string $name Property to check if set.
3383
-	 * @return bool Whether the property is set.
3383
+	 * @return boolean|null Whether the property is set.
3384 3384
 	 */
3385 3385
 	public function __isset( $name ) {
3386 3386
 		if ( in_array( $name, $this->compat_fields ) ) {
@@ -3981,7 +3981,7 @@  discard block
 block discarded – undo
3981 3981
 	 * @global int             $numpages
3982 3982
 	 *
3983 3983
 	 * @param WP_Post|object|int $post WP_Post instance or Post ID/object.
3984
-	 * @return true True when finished.
3984
+	 * @return null|boolean True when finished.
3985 3985
 	 */
3986 3986
 	public function setup_postdata( $post ) {
3987 3987
 		global $id, $authordata, $currentday, $currentmonth, $page, $pages, $multipage, $more, $numpages;
Please login to merge, or discard this patch.
src/wp-includes/class-wp-theme.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -457,7 +457,7 @@  discard block
 block discarded – undo
457 457
 	 *
458 458
 	 * @since  3.4.0
459 459
 	 *
460
-	 * @param mixed $offset
460
+	 * @param string $offset
461 461
 	 * @return mixed
462 462
 	 */
463 463
 	public function offsetGet( $offset ) {
@@ -513,7 +513,7 @@  discard block
 block discarded – undo
513 513
 	 * @since 3.4.0
514 514
 	 * @access public
515 515
 	 *
516
-	 * @return WP_Error|false WP_Error if there are errors, or false.
516
+	 * @return boolean WP_Error if there are errors, or false.
517 517
 	 */
518 518
 	public function errors() {
519 519
 		return is_wp_error( $this->errors ) ? $this->errors : false;
@@ -1007,7 +1007,7 @@  discard block
 block discarded – undo
1007 1007
 	 * @since 3.4.0
1008 1008
 	 * @access public
1009 1009
 	 *
1010
-	 * @param mixed $type Optional. Array of extensions to return. Defaults to all files (null).
1010
+	 * @param string $type Optional. Array of extensions to return. Defaults to all files (null).
1011 1011
 	 * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
1012 1012
 	 * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
1013 1013
 	 * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
Please login to merge, or discard this patch.
src/wp-includes/class-wp-user-query.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -655,7 +655,7 @@  discard block
 block discarded – undo
655 655
 	 * @access public
656 656
 	 *
657 657
 	 * @param string $query_var Query variable key.
658
-	 * @param mixed $value Query variable value.
658
+	 * @param string $value Query variable value.
659 659
 	 */
660 660
 	public function set( $query_var, $value ) {
661 661
 		$this->query_vars[$query_var] = $value;
@@ -837,7 +837,7 @@  discard block
 block discarded – undo
837 837
 	 * @access public
838 838
 	 *
839 839
 	 * @param string $name Property to check if set.
840
-	 * @return bool Whether the property is set.
840
+	 * @return boolean|null Whether the property is set.
841 841
 	 */
842 842
 	public function __isset( $name ) {
843 843
 		if ( in_array( $name, $this->compat_fields ) ) {
Please login to merge, or discard this patch.
src/wp-includes/class.wp-dependencies.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -270,7 +270,7 @@  discard block
 block discarded – undo
270 270
 	 * @since 2.1.0
271 271
 	 * @since 2.6.0 Moved from `WP_Scripts`.
272 272
 	 *
273
-	 * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
273
+	 * @param string $handles Item handle and argument (string) or item handles and arguments (array of strings).
274 274
 	 * @return void
275 275
 	 */
276 276
 	public function remove( $handles ) {
@@ -313,7 +313,7 @@  discard block
 block discarded – undo
313 313
 	 * @since 2.1.0
314 314
 	 * @since 2.6.0 Moved from `WP_Scripts`.
315 315
 	 *
316
-	 * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
316
+	 * @param string $handles Item handle and argument (string) or item handles and arguments (array of strings).
317 317
 	 */
318 318
 	public function dequeue( $handles ) {
319 319
 		foreach ( (array) $handles as $handle ) {
Please login to merge, or discard this patch.
src/wp-includes/comment-template.php 1 patch
Doc Comments   +22 added lines, -21 removed lines patch added patch discarded remove patch
@@ -17,7 +17,7 @@  discard block
 block discarded – undo
17 17
  * @since 1.5.0
18 18
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
19 19
  *
20
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
20
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
21 21
  *									 Default current comment.
22 22
  * @return string The comment author
23 23
  */
@@ -52,7 +52,7 @@  discard block
 block discarded – undo
52 52
  * @since 0.71
53 53
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
54 54
  *
55
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
55
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
56 56
  *									 Default current comment.
57 57
  */
58 58
 function comment_author( $comment_ID = 0 ) {
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
77 77
  * @since 1.5.0
78 78
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
79 79
  *
80
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's email.
80
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's email.
81 81
  *									 Default current comment.
82 82
  * @return string The current comment author's email
83 83
  */
@@ -109,7 +109,7 @@  discard block
 block discarded – undo
109 109
  * @since 0.71
110 110
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
111 111
  *
112
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's email.
112
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's email.
113 113
  *									 Default current comment.
114 114
  */
115 115
 function comment_author_email( $comment_ID = 0 ) {
@@ -209,7 +209,7 @@  discard block
 block discarded – undo
209 209
  * @since 1.5.0
210 210
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
211 211
  *
212
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's link.
212
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's link.
213 213
  *									 Default current comment.
214 214
  * @return string The comment author name or HTML link for author's URL.
215 215
  */
@@ -243,7 +243,7 @@  discard block
 block discarded – undo
243 243
  * @since 0.71
244 244
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
245 245
  *
246
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's link.
246
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's link.
247 247
  *									 Default current comment.
248 248
  */
249 249
 function comment_author_link( $comment_ID = 0 ) {
@@ -256,7 +256,7 @@  discard block
 block discarded – undo
256 256
  * @since 1.5.0
257 257
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
258 258
  *
259
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
259
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
260 260
  *									 Default current comment.
261 261
  * @return string Comment author's IP address.
262 262
  */
@@ -282,7 +282,7 @@  discard block
 block discarded – undo
282 282
  * @since 0.71
283 283
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
284 284
  *
285
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
285
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
286 286
  *									 Default current comment.
287 287
  */
288 288
 function comment_author_IP( $comment_ID = 0 ) {
@@ -295,7 +295,7 @@  discard block
 block discarded – undo
295 295
  * @since 1.5.0
296 296
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
297 297
  *
298
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
298
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
299 299
  *									 Default current comment.
300 300
  * @return string Comment author URL.
301 301
  */
@@ -328,7 +328,7 @@  discard block
 block discarded – undo
328 328
  * @since 0.71
329 329
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
330 330
  *
331
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's URL.
331
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's URL.
332 332
  *									 Default current comment.
333 333
  */
334 334
 function comment_author_url( $comment_ID = 0 ) {
@@ -366,7 +366,7 @@  discard block
 block discarded – undo
366 366
  *                                 Default empty.
367 367
  * @param string         $after    Optional. The text or HTML to display after the email link.
368 368
  *                                 Default empty.
369
- * @param int|WP_Comment $comment  Optional. Comment ID or WP_Comment object.
369
+ * @param integer $comment  Optional. Comment ID or WP_Comment object.
370 370
  *                                 Default is the current comment.
371 371
  * @return string The HTML link between the $before and $after parameters.
372 372
  */
@@ -404,7 +404,7 @@  discard block
 block discarded – undo
404 404
  *                                 Default empty.
405 405
  * @param string         $after    Optional. Text or HTML to display after the email link.
406 406
  *                                 Default empty.
407
- * @param int|WP_Comment $comment  Optional. Comment ID or WP_Comment object.
407
+ * @param integer $comment  Optional. Comment ID or WP_Comment object.
408 408
  *                                 Default is the current comment.
409 409
  */
410 410
 function comment_author_url_link( $linktext = '', $before = '', $after = '', $comment = 0 ) {
@@ -532,7 +532,7 @@  discard block
 block discarded – undo
532 532
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
533 533
  *
534 534
  * @param string          $d          Optional. The format of the date. Default user's setting.
535
- * @param int|WP_Comment  $comment_ID WP_Comment or ID of the comment for which to get the date.
535
+ * @param integer  $comment_ID WP_Comment or ID of the comment for which to get the date.
536 536
  *                                    Default current comment.
537 537
  * @return string The comment's date.
538 538
  */
@@ -561,7 +561,7 @@  discard block
 block discarded – undo
561 561
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
562 562
  *
563 563
  * @param string         $d          Optional. The format of the date. Default user's settings.
564
- * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the date.
564
+ * @param integer $comment_ID WP_Comment or ID of the comment for which to print the date.
565 565
  *                                   Default current comment.
566 566
  */
567 567
 function comment_date( $d = '', $comment_ID = 0 ) {
@@ -578,7 +578,7 @@  discard block
 block discarded – undo
578 578
  * @since 1.5.0
579 579
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
580 580
  *
581
- * @param int|WP_Comment $comment_ID  WP_Comment or ID of the comment for which to get the excerpt.
581
+ * @param integer $comment_ID  WP_Comment or ID of the comment for which to get the excerpt.
582 582
  *                                    Default current comment.
583 583
  * @return string The maybe truncated comment with 20 words or less.
584 584
  */
@@ -624,7 +624,7 @@  discard block
 block discarded – undo
624 624
  * @since 1.2.0
625 625
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
626 626
  *
627
- * @param int|WP_Comment $comment_ID  WP_Comment or ID of the comment for which to print the excerpt.
627
+ * @param integer $comment_ID  WP_Comment or ID of the comment for which to print the excerpt.
628 628
  *                                    Default current comment.
629 629
  */
630 630
 function comment_excerpt( $comment_ID = 0 ) {
@@ -795,7 +795,7 @@  discard block
 block discarded – undo
795 795
  *
796 796
  * @since 1.5.0
797 797
  *
798
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
798
+ * @param integer $post_id Optional. Post ID or WP_Post object. Default is global $post.
799 799
  * @return string The link to the comments.
800 800
  */
801 801
 function get_comments_link( $post_id = 0 ) {
@@ -834,7 +834,7 @@  discard block
 block discarded – undo
834 834
  *
835 835
  * @since 1.5.0
836 836
  *
837
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
837
+ * @param integer $post_id Optional. Post ID or WP_Post object. Default is global $post.
838 838
  * @return int The number of comments a post has.
839 839
  */
840 840
 function get_comments_number( $post_id = 0 ) {
@@ -943,7 +943,7 @@  discard block
 block discarded – undo
943 943
  *
944 944
  * @see Walker_Comment::comment()
945 945
  *
946
- * @param int|WP_Comment  $comment_ID WP_Comment or ID of the comment for which to get the text.
946
+ * @param integer  $comment_ID WP_Comment or ID of the comment for which to get the text.
947 947
  *                                    Default current comment.
948 948
  * @param array           $args       Optional. An array of arguments. Default empty.
949 949
  * @return string The comment content.
@@ -973,7 +973,7 @@  discard block
 block discarded – undo
973 973
  *
974 974
  * @see Walker_Comment::comment()
975 975
  *
976
- * @param int|WP_Comment  $comment_ID WP_Comment or ID of the comment for which to print the text.
976
+ * @param integer  $comment_ID WP_Comment or ID of the comment for which to print the text.
977 977
  *                                    Default current comment.
978 978
  * @param array           $args       Optional. An array of arguments. Default empty array. Default empty.
979 979
  */
@@ -1046,7 +1046,7 @@  discard block
 block discarded – undo
1046 1046
  * @since 1.5.0
1047 1047
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
1048 1048
  *
1049
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
1049
+ * @param integer $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
1050 1050
  *                                   Default current comment.
1051 1051
  * @return string The comment type.
1052 1052
  */
@@ -1921,6 +1921,7 @@  discard block
 block discarded – undo
1921 1921
  *     @type bool   $echo              Whether to echo the output or return it. Default true.
1922 1922
  * }
1923 1923
  * @param array $comments Optional. Array of WP_Comment objects.
1924
+ * @return string
1924 1925
  */
1925 1926
 function wp_list_comments( $args = array(), $comments = null ) {
1926 1927
 	global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;
Please login to merge, or discard this patch.
src/wp-includes/cron.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -424,7 +424,7 @@
 block discarded – undo
424 424
  * @since 2.1.0
425 425
  *
426 426
  * @param string $hook Action hook to identify the event.
427
- * @param array $args Optional. Arguments passed to the event's callback function.
427
+ * @param string[] $args Optional. Arguments passed to the event's callback function.
428 428
  * @return string|false False, if no schedule. Schedule name on success.
429 429
  */
430 430
 function wp_get_schedule($hook, $args = array()) {
Please login to merge, or discard this patch.
src/wp-includes/deprecated.php 1 patch
Doc Comments   +5 added lines, -6 removed lines patch added patch discarded remove patch
@@ -610,7 +610,7 @@  discard block
 block discarded – undo
610 610
  * @param string $feed_image
611 611
  * @param string $exclude
612 612
  * @param bool $hierarchical
613
- * @return false|null
613
+ * @return false|string
614 614
  */
615 615
 function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0,
616 616
 				   $optioncount = 0, $hide_empty = 1, $use_desc_for_title = 1, $children=false, $child_of=0, $categories=0,
@@ -630,7 +630,7 @@  discard block
 block discarded – undo
630 630
  * @see wp_list_categories()
631 631
  *
632 632
  * @param string|array $args
633
- * @return false|null|string
633
+ * @return false|string
634 634
  */
635 635
 function wp_list_cats($args = '') {
636 636
 	_deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_categories()' );
@@ -2101,7 +2101,6 @@  discard block
 block discarded – undo
2101 2101
  * @param string|int $name            Widget ID.
2102 2102
  * @param callable   $output_callback Run when widget is called.
2103 2103
  * @param string     $classname       Optional. Classname widget option. Default empty.
2104
- * @param mixed      $params ,...     Widget parameters.
2105 2104
  */
2106 2105
 function register_sidebar_widget($name, $output_callback, $classname = '') {
2107 2106
 	_deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_sidebar_widget()' );
@@ -2419,7 +2418,7 @@  discard block
 block discarded – undo
2419 2418
  * @see count_user_posts()
2420 2419
  *
2421 2420
  * @param int $userid User to count posts for.
2422
- * @return int Number of posts the given user has written.
2421
+ * @return string Number of posts the given user has written.
2423 2422
  */
2424 2423
 function get_usernumposts( $userid ) {
2425 2424
 	_deprecated_function( __FUNCTION__, '3.0.0', 'count_user_posts()' );
@@ -2942,7 +2941,7 @@  discard block
 block discarded – undo
2942 2941
  * @since 1.2.0
2943 2942
  * @deprecated 3.4.0
2944 2943
  *
2945
- * @param array|string $matches The array or string
2944
+ * @param string $matches The array or string
2946 2945
  * @return string The pre block without paragraph/line-break conversion.
2947 2946
  */
2948 2947
 function clean_pre($matches) {
@@ -3605,7 +3604,7 @@  discard block
 block discarded – undo
3605 3604
  * @deprecated 4.4.0 Use get_permalink()
3606 3605
  * @see get_permalink()
3607 3606
  *
3608
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
3607
+ * @param integer $post_id Optional. Post ID or WP_Post object. Default is global $post.
3609 3608
  * @return string|false
3610 3609
  */
3611 3610
 function post_permalink( $post_id = 0 ) {
Please login to merge, or discard this patch.
src/wp-includes/embed.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -624,7 +624,7 @@
 block discarded – undo
624 624
  * @since 4.4.0
625 625
  *
626 626
  * @param bool                      $served  Whether the request has already been served.
627
- * @param WP_HTTP_ResponseInterface $result  Result to send to the client. Usually a WP_REST_Response.
627
+ * @param WP_REST_Response $result  Result to send to the client. Usually a WP_REST_Response.
628 628
  * @param WP_REST_Request           $request Request used to generate the response.
629 629
  * @param WP_REST_Server            $server  Server instance.
630 630
  * @return true
Please login to merge, or discard this patch.
src/wp-includes/formatting.php 1 patch
Doc Comments   +2 added lines, -3 removed lines patch added patch discarded remove patch
@@ -958,7 +958,7 @@  discard block
 block discarded – undo
958 958
  * @since 2.8.0
959 959
  *
960 960
  * @param string     $string The text which is to be decoded.
961
- * @param string|int $quote_style Optional. Converts double quotes if set to ENT_COMPAT,
961
+ * @param integer $quote_style Optional. Converts double quotes if set to ENT_COMPAT,
962 962
  *                                both single and double if set to ENT_QUOTES or
963 963
  *                                none if set to ENT_NOQUOTES.
964 964
  *                                Also compatible with old _wp_specialchars() values;
@@ -3715,7 +3715,7 @@  discard block
 block discarded – undo
3715 3715
  * @since 2.8.1
3716 3716
  * @access private
3717 3717
  *
3718
- * @param string|array $search  The value being searched for, otherwise known as the needle.
3718
+ * @param string[] $search  The value being searched for, otherwise known as the needle.
3719 3719
  *                              An array may be used to designate multiple needles.
3720 3720
  * @param string       $subject The string being searched and replaced on, otherwise known as the haystack.
3721 3721
  * @return string The string with the replaced svalues.
@@ -4381,7 +4381,6 @@  discard block
 block discarded – undo
4381 4381
  * @link https://secure.php.net/sprintf
4382 4382
  *
4383 4383
  * @param string $pattern   The string which formatted args are inserted.
4384
- * @param mixed  $args ,... Arguments to be formatted into the $pattern string.
4385 4384
  * @return string The formatted string.
4386 4385
  */
4387 4386
 function wp_sprintf( $pattern ) {
Please login to merge, or discard this patch.