ntwb / wordpress

src/wp-includes/class-wp-query.php

Doc Comments +4 added lines, -4 removed lines

@@ -1374,7 +1374,7 @@ 
 	 *
 	 * @since 3.7.0
 	 *
-	 * @param array $terms Terms to check.
+	 * @param string[] $terms Terms to check.
 	 * @return array Terms that are not stopwords.
 	 */
 	protected function parse_search_terms( $terms ) {
@@ -1629,7 +1629,7 @@ 
 	 * @access public
 	 *
 	 * @param string $query_var Query variable key.
-	 * @param mixed  $default   Optional. Value to return if the query variable is not set. Default empty.
+	 * @param boolean  $default   Optional. Value to return if the query variable is not set. Default empty.
 	 * @return mixed Contents of the query variable.
 	 */
 	public function get( $query_var, $default = '' ) {
@@ -3380,7 +3380,7 @@ 
 	 * @access public
 	 *
 	 * @param string $name Property to check if set.
-	 * @return bool Whether the property is set.
+	 * @return boolean|null Whether the property is set.
 	 */
 	public function __isset( $name ) {
 		if ( in_array( $name, $this->compat_fields ) ) {
@@ -3981,7 +3981,7 @@ 
 	 * @global int             $numpages
 	 *
 	 * @param WP_Post|object|int $post WP_Post instance or Post ID/object.
-	 * @return true True when finished.
+	 * @return null|boolean True when finished.
 	 */
 	public function setup_postdata( $post ) {
 		global $id, $authordata, $currentday, $currentmonth, $page, $pages, $multipage, $more, $numpages;

src/wp-includes/class-wp-theme.php

Doc Comments +3 added lines, -3 removed lines

@@ -457,7 +457,7 @@ 
 	 *
 	 * @since  3.4.0
 	 *
-	 * @param mixed $offset
+	 * @param string $offset
 	 * @return mixed
 	 */
 	public function offsetGet( $offset ) {
@@ -513,7 +513,7 @@ 
 	 * @since 3.4.0
 	 * @access public
 	 *
-	 * @return WP_Error|false WP_Error if there are errors, or false.
+	 * @return boolean WP_Error if there are errors, or false.
 	 */
 	public function errors() {
 		return is_wp_error( $this->errors ) ? $this->errors : false;
@@ -1007,7 +1007,7 @@ 
 	 * @since 3.4.0
 	 * @access public
 	 *
-	 * @param mixed $type Optional. Array of extensions to return. Defaults to all files (null).
+	 * @param string $type Optional. Array of extensions to return. Defaults to all files (null).
 	 * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
 	 * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
 	 * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values

src/wp-includes/class-wp-user-query.php

Doc Comments +2 added lines, -2 removed lines

@@ -655,7 +655,7 @@ 
 	 * @access public
 	 *
 	 * @param string $query_var Query variable key.
-	 * @param mixed $value Query variable value.
+	 * @param string $value Query variable value.
 	 */
 	public function set( $query_var, $value ) {
 		$this->query_vars[$query_var] = $value;
@@ -837,7 +837,7 @@ 
 	 * @access public
 	 *
 	 * @param string $name Property to check if set.
-	 * @return bool Whether the property is set.
+	 * @return boolean|null Whether the property is set.
 	 */
 	public function __isset( $name ) {
 		if ( in_array( $name, $this->compat_fields ) ) {

src/wp-includes/class.wp-dependencies.php

Doc Comments +2 added lines, -2 removed lines

@@ -270,7 +270,7 @@ 
 	 * @since 2.1.0
 	 * @since 2.6.0 Moved from `WP_Scripts`.
 	 *
-	 * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+	 * @param string $handles Item handle and argument (string) or item handles and arguments (array of strings).
 	 * @return void
 	 */
 	public function remove( $handles ) {
@@ -313,7 +313,7 @@ 
 	 * @since 2.1.0
 	 * @since 2.6.0 Moved from `WP_Scripts`.
 	 *
-	 * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+	 * @param string $handles Item handle and argument (string) or item handles and arguments (array of strings).
 	 */
 	public function dequeue( $handles ) {
 		foreach ( (array) $handles as $handle ) {

src/wp-includes/comment-template.php

Doc Comments +22 added lines, -21 removed lines

@@ -17,7 +17,7 @@ 
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
  *									 Default current comment.
  * @return string The comment author
  */
@@ -52,7 +52,7 @@ 
  * @since 0.71
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
  *									 Default current comment.
  */
 function comment_author( $comment_ID = 0 ) {
@@ -77,7 +77,7 @@ 
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's email.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's email.
  *									 Default current comment.
  * @return string The current comment author's email
  */
@@ -109,7 +109,7 @@ 
  * @since 0.71
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's email.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's email.
  *									 Default current comment.
  */
 function comment_author_email( $comment_ID = 0 ) {
@@ -209,7 +209,7 @@ 
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's link.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's link.
  *									 Default current comment.
  * @return string The comment author name or HTML link for author's URL.
  */
@@ -243,7 +243,7 @@ 
  * @since 0.71
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's link.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's link.
  *									 Default current comment.
  */
 function comment_author_link( $comment_ID = 0 ) {
@@ -256,7 +256,7 @@ 
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
  *									 Default current comment.
  * @return string Comment author's IP address.
  */
@@ -282,7 +282,7 @@ 
  * @since 0.71
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
  *									 Default current comment.
  */
 function comment_author_IP( $comment_ID = 0 ) {
@@ -295,7 +295,7 @@ 
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
  *									 Default current comment.
  * @return string Comment author URL.
  */
@@ -328,7 +328,7 @@ 
  * @since 0.71
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's URL.
+ * @param integer $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's URL.
  *									 Default current comment.
  */
 function comment_author_url( $comment_ID = 0 ) {
@@ -366,7 +366,7 @@ 
  *                                 Default empty.
  * @param string         $after    Optional. The text or HTML to display after the email link.
  *                                 Default empty.
- * @param int|WP_Comment $comment  Optional. Comment ID or WP_Comment object.
+ * @param integer $comment  Optional. Comment ID or WP_Comment object.
  *                                 Default is the current comment.
  * @return string The HTML link between the $before and $after parameters.
  */
@@ -404,7 +404,7 @@ 
  *                                 Default empty.
  * @param string         $after    Optional. Text or HTML to display after the email link.
  *                                 Default empty.
- * @param int|WP_Comment $comment  Optional. Comment ID or WP_Comment object.
+ * @param integer $comment  Optional. Comment ID or WP_Comment object.
  *                                 Default is the current comment.
  */
 function comment_author_url_link( $linktext = '', $before = '', $after = '', $comment = 0 ) {
@@ -532,7 +532,7 @@ 
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
  * @param string          $d          Optional. The format of the date. Default user's setting.
- * @param int|WP_Comment  $comment_ID WP_Comment or ID of the comment for which to get the date.
+ * @param integer  $comment_ID WP_Comment or ID of the comment for which to get the date.
  *                                    Default current comment.
  * @return string The comment's date.
  */
@@ -561,7 +561,7 @@ 
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
  * @param string         $d          Optional. The format of the date. Default user's settings.
- * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the date.
+ * @param integer $comment_ID WP_Comment or ID of the comment for which to print the date.
  *                                   Default current comment.
  */
 function comment_date( $d = '', $comment_ID = 0 ) {
@@ -578,7 +578,7 @@ 
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID  WP_Comment or ID of the comment for which to get the excerpt.
+ * @param integer $comment_ID  WP_Comment or ID of the comment for which to get the excerpt.
  *                                    Default current comment.
  * @return string The maybe truncated comment with 20 words or less.
  */
@@ -624,7 +624,7 @@ 
  * @since 1.2.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID  WP_Comment or ID of the comment for which to print the excerpt.
+ * @param integer $comment_ID  WP_Comment or ID of the comment for which to print the excerpt.
  *                                    Default current comment.
  */
 function comment_excerpt( $comment_ID = 0 ) {
@@ -795,7 +795,7 @@ 
  *
  * @since 1.5.0
  *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
+ * @param integer $post_id Optional. Post ID or WP_Post object. Default is global $post.
  * @return string The link to the comments.
  */
 function get_comments_link( $post_id = 0 ) {
@@ -834,7 +834,7 @@ 
  *
  * @since 1.5.0
  *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
+ * @param integer $post_id Optional. Post ID or WP_Post object. Default is global $post.
  * @return int The number of comments a post has.
  */
 function get_comments_number( $post_id = 0 ) {
@@ -943,7 +943,7 @@ 
  *
  * @see Walker_Comment::comment()
  *
- * @param int|WP_Comment  $comment_ID WP_Comment or ID of the comment for which to get the text.
+ * @param integer  $comment_ID WP_Comment or ID of the comment for which to get the text.
  *                                    Default current comment.
  * @param array           $args       Optional. An array of arguments. Default empty.
  * @return string The comment content.
@@ -973,7 +973,7 @@ 
  *
  * @see Walker_Comment::comment()
  *
- * @param int|WP_Comment  $comment_ID WP_Comment or ID of the comment for which to print the text.
+ * @param integer  $comment_ID WP_Comment or ID of the comment for which to print the text.
  *                                    Default current comment.
  * @param array           $args       Optional. An array of arguments. Default empty array. Default empty.
  */
@@ -1046,7 +1046,7 @@ 
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
+ * @param integer $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
  *                                   Default current comment.
  * @return string The comment type.
  */
@@ -1921,6 +1921,7 @@ 
  *     @type bool   $echo              Whether to echo the output or return it. Default true.
  * }
  * @param array $comments Optional. Array of WP_Comment objects.
+ * @return string
  */
 function wp_list_comments( $args = array(), $comments = null ) {
 	global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;

src/wp-includes/cron.php

Doc Comments +1 added lines, -1 removed lines

@@ -424,7 +424,7 @@
  * @since 2.1.0
  *
  * @param string $hook Action hook to identify the event.
- * @param array $args Optional. Arguments passed to the event's callback function.
+ * @param string[] $args Optional. Arguments passed to the event's callback function.
  * @return string|false False, if no schedule. Schedule name on success.
  */
 function wp_get_schedule($hook, $args = array()) {

src/wp-includes/deprecated.php

Doc Comments +5 added lines, -6 removed lines

@@ -610,7 +610,7 @@ 
  * @param string $feed_image
  * @param string $exclude
  * @param bool $hierarchical
- * @return false|null
+ * @return false|string
  */
 function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0,
 				   $optioncount = 0, $hide_empty = 1, $use_desc_for_title = 1, $children=false, $child_of=0, $categories=0,
@@ -630,7 +630,7 @@ 
  * @see wp_list_categories()
  *
  * @param string|array $args
- * @return false|null|string
+ * @return false|string
  */
 function wp_list_cats($args = '') {
 	_deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_categories()' );
@@ -2101,7 +2101,6 @@ 
  * @param string|int $name            Widget ID.
  * @param callable   $output_callback Run when widget is called.
  * @param string     $classname       Optional. Classname widget option. Default empty.
- * @param mixed      $params ,...     Widget parameters.
  */
 function register_sidebar_widget($name, $output_callback, $classname = '') {
 	_deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_sidebar_widget()' );
@@ -2419,7 +2418,7 @@ 
  * @see count_user_posts()
  *
  * @param int $userid User to count posts for.
- * @return int Number of posts the given user has written.
+ * @return string Number of posts the given user has written.
  */
 function get_usernumposts( $userid ) {
 	_deprecated_function( __FUNCTION__, '3.0.0', 'count_user_posts()' );
@@ -2942,7 +2941,7 @@ 
  * @since 1.2.0
  * @deprecated 3.4.0
  *
- * @param array|string $matches The array or string
+ * @param string $matches The array or string
  * @return string The pre block without paragraph/line-break conversion.
  */
 function clean_pre($matches) {
@@ -3605,7 +3604,7 @@ 
  * @deprecated 4.4.0 Use get_permalink()
  * @see get_permalink()
  *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
+ * @param integer $post_id Optional. Post ID or WP_Post object. Default is global $post.
  * @return string|false
  */
 function post_permalink( $post_id = 0 ) {

src/wp-includes/embed.php

Doc Comments +1 added lines, -1 removed lines

@@ -624,7 +624,7 @@
  * @since 4.4.0
  *
  * @param bool                      $served  Whether the request has already been served.
- * @param WP_HTTP_ResponseInterface $result  Result to send to the client. Usually a WP_REST_Response.
+ * @param WP_REST_Response $result  Result to send to the client. Usually a WP_REST_Response.
  * @param WP_REST_Request           $request Request used to generate the response.
  * @param WP_REST_Server            $server  Server instance.
  * @return true

src/wp-includes/formatting.php

Doc Comments +2 added lines, -3 removed lines

@@ -958,7 +958,7 @@ 
  * @since 2.8.0
  *
  * @param string     $string The text which is to be decoded.
- * @param string|int $quote_style Optional. Converts double quotes if set to ENT_COMPAT,
+ * @param integer $quote_style Optional. Converts double quotes if set to ENT_COMPAT,
  *                                both single and double if set to ENT_QUOTES or
  *                                none if set to ENT_NOQUOTES.
  *                                Also compatible with old _wp_specialchars() values;
@@ -3715,7 +3715,7 @@ 
  * @since 2.8.1
  * @access private
  *
- * @param string|array $search  The value being searched for, otherwise known as the needle.
+ * @param string[] $search  The value being searched for, otherwise known as the needle.
  *                              An array may be used to designate multiple needles.
  * @param string       $subject The string being searched and replaced on, otherwise known as the haystack.
  * @return string The string with the replaced svalues.
@@ -4381,7 +4381,6 @@ 
  * @link https://secure.php.net/sprintf
  *
  * @param string $pattern   The string which formatted args are inserted.
- * @param mixed  $args ,... Arguments to be formatted into the $pattern string.
  * @return string The formatted string.
  */
 function wp_sprintf( $pattern ) {