staylor / WordPress

wp-includes/embed.php

Doc Comments +1 added lines, -1 removed lines

@@ -481,7 +481,7 @@
  *
  * @param WP_Post|int $post  Post object or ID.
  * @param int         $width The requested width.
- * @return array|false Response data on success, false if post doesn't exist.
+ * @return string Response data on success, false if post doesn't exist.
  */
 function get_oembed_response_data( $post, $width ) {
 	$post  = get_post( $post );

wp-includes/feed.php

Doc Comments +1 added lines, -1 removed lines

@@ -531,7 +531,7 @@
  * @since 2.5.0
  *
  * @param string $data Input string
- * @return array array(type, value)
+ * @return string[] array(type, value)
  */
 function prep_atom_text_construct($data) {
 	if (strpos($data, '<') === false && strpos($data, '&') === false) {

wp-includes/formatting.php

Doc Comments +3 added lines, -4 removed lines

@@ -879,7 +879,7 @@ 
  * @staticvar string $_charset
  *
  * @param string     $string         The text which is to be encoded.
- * @param int|string $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 values; converting single quotes if set to 'single',
  *                                   double if set to 'double' or both if otherwise set.
@@ -952,7 +952,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;
@@ -3692,7 +3692,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.
@@ -4358,7 +4358,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 ) {

wp-includes/functions.php

Doc Comments +8 added lines, -11 removed lines

@@ -55,7 +55,7 @@ 
  *
  * @param string   $type Type of time to retrieve. Accepts 'mysql', 'timestamp', or PHP date
  *                       format string (e.g. 'Y-m-d').
- * @param int|bool $gmt  Optional. Whether to use GMT timezone. Default false.
+ * @param integer $gmt  Optional. Whether to use GMT timezone. Default false.
  * @return int|string Integer if $type is 'timestamp', string otherwise.
  */
 function current_time( $type, $gmt = 0 ) {
@@ -436,7 +436,7 @@ 
  * @since 2.0.5
  *
  * @param string|array|object $data Data that might be serialized.
- * @return mixed A scalar data
+ * @return string A scalar data
  */
 function maybe_serialize( $data ) {
 	if ( is_array( $data ) || is_object( $data ) )
@@ -771,9 +771,6 @@ 
  *
  * @since 1.5.0
  *
- * @param string|array $key   Either a query variable key, or an associative array of query variables.
- * @param string       $value Optional. Either a query variable value, or a URL to act upon.
- * @param string       $url   Optional. A URL to act upon.
  * @return string New URL query string (unescaped).
  */
 function add_query_arg() {
@@ -1428,7 +1425,7 @@ 
  * @since 2.0.4
  *
  * @param string     $actionurl URL to add nonce action.
- * @param int|string $action    Optional. Nonce action name. Default -1.
+ * @param integer $action    Optional. Nonce action name. Default -1.
  * @param string     $name      Optional. Nonce name. Default '_wpnonce'.
  * @return string Escaped URL with nonce action added.
  */
@@ -1457,7 +1454,7 @@ 
  *
  * @since 2.0.4
  *
- * @param int|string $action  Optional. Action name. Default -1.
+ * @param integer $action  Optional. Action name. Default -1.
  * @param string     $name    Optional. Nonce name. Default '_wpnonce'.
  * @param bool       $referer Optional. Whether to set the referer field for validation. Default true.
  * @param bool       $echo    Optional. Whether to display or return hidden form field. Default true.
@@ -1549,7 +1546,7 @@ 
  *
  * @since 4.5.0
  *
- * @return string|false Referer URL on success, false on failure.
+ * @return string Referer URL on success, false on failure.
  */
 function wp_get_raw_referer() {
 	if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
@@ -1861,7 +1858,7 @@ 
  * @param bool   $create_dir Optional. Whether to check and create the uploads directory.
  *                           Default true for backward compatibility.
  * @param bool   $refresh_cache Optional. Whether to refresh the cache. Default false.
- * @return array See above for description.
+ * @return callable|null See above for description.
  */
 function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) {
 	static $cache = array(), $tested_paths = array();
@@ -4692,7 +4689,7 @@ 
  *
  * @see __return_false()
  *
- * @return true True.
+ * @return boolean True.
  */
 function __return_true() {
 	return true;
@@ -4814,7 +4811,7 @@ 
  * @param int      $start         The ID to start the loop check at.
  * @param int      $start_parent  The parent_ID of $start to use instead of calling $callback( $start ).
  *                                Use null to always use $callback
- * @param array    $callback_args Optional. Additional arguments to send to $callback.
+ * @param string[]    $callback_args Optional. Additional arguments to send to $callback.
  * @return array IDs of all members of loop.
  */
 function wp_find_hierarchy_loop( $callback, $start, $start_parent, $callback_args = array() ) {

wp-includes/functions.wp-styles.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
  *
  * @since 2.6.0
  *
- * @param string|bool|array $handles Styles to be printed. Default 'false'.
+ * @param string $handles Styles to be printed. Default 'false'.
  * @return array On success, a processed array of WP_Dependencies items; otherwise, an empty array.
  */
 function wp_print_styles( $handles = false ) {

wp-includes/general-template.php

Doc Comments +3 added lines, -3 removed lines

@@ -1842,7 +1842,7 @@ 
  * @since 1.5.0
  *
  * @param int $num Number of day.
- * @return int Days since the start of the week.
+ * @return double Days since the start of the week.
  */
 function calendar_week_mod($num) {
 	$base = 7;
@@ -3158,7 +3158,7 @@ 
  *     @type string $before_page_number A string to appear before the page number. Default empty.
  *     @type string $after_page_number  A string to append after the page number. Default empty.
  * }
- * @return array|string|void String of page links or array of page links.
+ * @return string String of page links or array of page links.
  */
 function paginate_links( $args = '' ) {
 	global $wp_query, $wp_rewrite;
@@ -3319,7 +3319,7 @@ 
  * @param string $key    The unique key for this theme.
  * @param string $name   The name of the theme.
  * @param string $url    The URL of the CSS file containing the color scheme.
- * @param array  $colors Optional. An array of CSS color definition strings which are used
+ * @param string[]  $colors Optional. An array of CSS color definition strings which are used
  *                       to give the user a feel for the theme.
  * @param array  $icons {
  *     Optional. CSS color definitions used to color any SVG icons.

wp-includes/link-template.php

Doc Comments +6 added lines, -6 removed lines

@@ -12,7 +12,7 @@ 
  * @since 1.2.0
  * @since 4.4.0 Added the `$post` parameter.
  *
- * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
+ * @param integer $post Optional. Post ID or post object. Default is the global `$post`.
  */
 function the_permalink( $post = 0 ) {
 	/**
@@ -97,7 +97,7 @@ 
  *
  * @see get_permalink()
  *
- * @param int|WP_Post $post      Optional. Post ID or post object. Default is the global `$post`.
+ * @param integer $post      Optional. Post ID or post object. Default is the global `$post`.
  * @param bool        $leavename Optional. Whether to keep post name or page name. Default false.
  *
  * @return string|false The permalink URL or false if post does not exist.
@@ -111,7 +111,7 @@ 
  *
  * @since 1.0.0
  *
- * @param int|WP_Post $post      Optional. Post ID or post object. Default is the global `$post`.
+ * @param integer $post      Optional. Post ID or post object. Default is the global `$post`.
  * @param bool        $leavename Optional. Whether to keep post name or page name. Default false.
  * @return string|false The permalink URL or false if post does not exist.
  */
@@ -1387,7 +1387,7 @@ 
  *
  * @since 2.3.0
  *
- * @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object.
+ * @param integer $comment_id Optional. Comment ID or WP_Comment object.
  * @return string|void The edit comment link URL for the given comment.
  */
 function get_edit_comment_link( $comment_id = 0 ) {
@@ -1447,7 +1447,7 @@ 
  *
  * @since 2.7.0
  *
- * @param int|stdClass $link Optional. Bookmark ID. Default is the id of the current bookmark.
+ * @param integer $link Optional. Bookmark ID. Default is the id of the current bookmark.
  * @return string|void The edit bookmark link URL.
  */
 function get_edit_bookmark_link( $link = 0 ) {
@@ -2761,7 +2761,7 @@ 
  * @global WP_Rewrite $wp_rewrite
  *
  * @param string|array $args Optional args. See paginate_links(). Default empty array.
- * @return string|void Markup for pagination links.
+ * @return string Markup for pagination links.
  */
 function paginate_comments_links( $args = array() ) {
 	global $wp_rewrite;

wp-includes/load.php

Doc Comments +1 added lines, -1 removed lines

@@ -253,7 +253,7 @@
  * @global float   $timestart Seconds from when timer_start() is called.
  * @global float   $timeend   Seconds from when function is called.
  *
- * @param int|bool $display   Whether to echo or return the results. Accepts 0|false for return,
+ * @param integer $display   Whether to echo or return the results. Accepts 0|false for return,
  *                            1|true for echo. Default 0|false.
  * @param int      $precision The number of digits from the right of the decimal to display.
  *                            Default 3.

wp-includes/media.php

Doc Comments +8 added lines, -8 removed lines

@@ -982,7 +982,7 @@ 
  *                                    width and height values in pixels (in that order). Default 'medium'.
  * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
  *                                    Default null.
- * @return string|bool A 'srcset' value string or false.
+ * @return false|string A 'srcset' value string or false.
  */
 function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null ) {
 	if ( ! $image = wp_get_attachment_image_src( $attachment_id, $size ) ) {
@@ -1011,7 +1011,7 @@ 
  * @param string $image_src     The 'src' of the image.
  * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
  * @param int    $attachment_id Optional. The image attachment ID to pass to the filter. Default 0.
- * @return string|bool          The 'srcset' attribute value. False on error or when only one source exists.
+ * @return false|string          The 'srcset' attribute value. False on error or when only one source exists.
  */
 function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) {
 	/**
@@ -3523,7 +3523,7 @@ 
  * @since 3.6.0
  *
  * @param string      $type Mime type.
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @param integer $post Optional. Post ID or WP_Post object. Default is global $post.
  * @return array Found attachments.
  */
 function get_attached_media( $type, $post = 0 ) {
@@ -3610,7 +3610,7 @@ 
  *
  * @since 3.6.0
  *
- * @param int|WP_Post $post Post ID or object.
+ * @param integer $post Post ID or object.
  * @param bool        $html Optional. Whether to return HTML or data in the array. Default true.
  * @return array A list of arrays, each containing gallery data and srcs parsed
  *               from the expanded shortcode.
@@ -3662,7 +3662,7 @@ 
  *
  * @since 3.6.0
  *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @param integer $post Optional. Post ID or WP_Post object. Default is global $post.
  * @param bool        $html Optional. Whether to return HTML or data. Default is true.
  * @return string|array Gallery data and srcs parsed from the expanded shortcode.
  */
@@ -3689,7 +3689,7 @@ 
  *
  * @see get_post_galleries()
  *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @param integer $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @return array A list of lists, each containing image srcs parsed.
  *               from an expanded shortcode
  */
@@ -3705,7 +3705,7 @@ 
  *
  * @see get_post_gallery()
  *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @param integer $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @return array A list of a gallery's image srcs in order.
  */
 function get_post_gallery_images( $post = 0 ) {
@@ -3790,7 +3790,7 @@ 
  *
  * @global string $wp_version
  *
- * @return array The relevant CSS file URLs.
+ * @return string[] The relevant CSS file URLs.
  */
 function wpview_media_sandbox_styles() {
  	$version = 'ver=' . $GLOBALS['wp_version'];