ntwb / wordpress

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 ) {

src/wp-includes/ms-blogs.php

Doc Comments +3 added lines, -3 removed lines

@@ -697,7 +697,7 @@ 
  *
  * @param int    $id     A blog ID. Can be null to refer to the current blog.
  * @param string $option Name of option to add. Expected to not be SQL-escaped.
- * @param mixed  $value  Optional. Option value, can be anything. Expected to not be SQL-escaped.
+ * @param string  $value  Optional. Option value, can be anything. Expected to not be SQL-escaped.
  * @return bool False if option was not added and true if option was added.
  */
 function add_blog_option( $id, $option, $value ) {
@@ -748,7 +748,7 @@ 
  *
  * @param int    $id         The blog id.
  * @param string $option     The option key.
- * @param mixed  $value      The option value.
+ * @param string  $value      The option value.
  * @param mixed  $deprecated Not used.
  * @return bool True on success, false on failure.
  */
@@ -790,7 +790,7 @@ 
  *
  * @param int  $new_blog   The id of the blog you want to switch to. Default: current blog
  * @param bool $deprecated Deprecated argument
- * @return true Always returns True.
+ * @return boolean Always returns True.
  */
 function switch_to_blog( $new_blog, $deprecated = null ) {
 	global $wpdb, $wp_roles;

src/wp-includes/nav-menu-template.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
  *                                               Uses printf() format with numbered placeholders.
  *     @type string             $item_spacing    Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'.
  * }
- * @return string|false|void Menu output if $echo is false, false if there are no items or no menu was found.
+ * @return string Menu output if $echo is false, false if there are no items or no menu was found.
  */
 function wp_nav_menu( $args = array() ) {
 	static $menu_id_slugs = array();

src/wp-includes/pluggable.php

Doc Comments +8 added lines, -8 removed lines

@@ -745,7 +745,7 @@ 
  *
  * @param string $cookie
  * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
- * @return array|false Authentication cookie components
+ * @return string Authentication cookie components
  */
 function wp_parse_auth_cookie($cookie = '', $scheme = '') {
 	if ( empty($cookie) ) {
@@ -1063,7 +1063,7 @@ 
  *
  * @since 1.2.0
  *
- * @param int|string $action    Action nonce.
+ * @param integer $action    Action nonce.
  * @param string     $query_arg Optional. Key to check for nonce in `$_REQUEST` (since 2.5).
  *                              Default '_wpnonce'.
  * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
@@ -1103,7 +1103,7 @@ 
  *
  * @since 2.0.3
  *
- * @param int|string   $action    Action nonce.
+ * @param integer   $action    Action nonce.
  * @param false|string $query_arg Optional. Key to check for the nonce in `$_REQUEST` (since 2.5). If false,
  *                                `$_REQUEST` values will be evaluated for '_ajax_nonce', and '_wpnonce'
  *                                (in that order). Default false.
@@ -1578,7 +1578,7 @@ 
  * should be notified, overriding the site setting.
  *
  * @param int $comment_id Comment ID.
- * @return true Always returns true.
+ * @return boolean Always returns true.
  */
 function wp_notify_moderator($comment_id) {
 	global $wpdb;
@@ -1768,7 +1768,7 @@ 
  * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
  *
  * @param int    $user_id    User ID.
- * @param null   $deprecated Not used (argument deprecated).
+ * @param null|string   $deprecated Not used (argument deprecated).
  * @param string $notify     Optional. Type of notification that should happen. Accepts 'admin' or an empty
  *                           string (admin only), 'user', or 'both' (admin and user). Default empty.
  */
@@ -1867,8 +1867,8 @@ 
  * @since 2.0.3
  *
  * @param string     $nonce  Nonce that was used in the form to verify
- * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
- * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
+ * @param integer $action Should give context to what is taking place and be the same when nonce was created.
+ * @return string False if the nonce is invalid, 1 if the nonce is valid and generated between
  *                   0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
  */
 function wp_verify_nonce( $nonce, $action = -1 ) {
@@ -1931,7 +1931,7 @@ 
  * @since 2.0.3
  * @since 4.0.0 Session tokens were integrated with nonce creation
  *
- * @param string|int $action Scalar value to add context to the nonce.
+ * @param integer $action Scalar value to add context to the nonce.
  * @return string The token.
  */
 function wp_create_nonce($action = -1) {

src/wp-includes/plugin.php

Doc Comments +5 added lines, -8 removed lines

@@ -101,7 +101,7 @@ 
  *                                  and functions with the same priority are executed
  *                                  in the order in which they were added to the action.
  * @param int      $accepted_args   Optional. The number of arguments the function accepts. Default 1.
- * @return true
+ * @return boolean
  */
 function add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
 	global $wp_filter;
@@ -170,7 +170,6 @@ 
  *
  * @param string $tag     The name of the filter hook.
  * @param mixed  $value   The value on which the filters hooked to `$tag` are applied on.
- * @param mixed  $var,... Additional variables passed to the functions hooked to `$tag`.
  * @return mixed The filtered value after all hooked functions are applied to it.
  */
 function apply_filters( $tag, $value ) {
@@ -291,7 +290,7 @@ 
  *
  * @param string   $tag      The filter to remove hooks from.
  * @param int|bool $priority Optional. The priority number to remove. Default false.
- * @return true True when finished.
+ * @return boolean True when finished.
  */
 function remove_all_filters( $tag, $priority = false ) {
 	global $wp_filter;
@@ -393,7 +392,7 @@ 
  *                                  and functions with the same priority are executed
  *                                  in the order in which they were added to the action.
  * @param int      $accepted_args   Optional. The number of arguments the function accepts. Default 1.
- * @return true Will always return true.
+ * @return boolean Will always return true.
  */
 function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
 	return add_filter($tag, $function_to_add, $priority, $accepted_args);
@@ -415,8 +414,6 @@ 
  * @global array $wp_current_filter Stores the list of current filters with the current one last
  *
  * @param string $tag     The name of the action to be executed.
- * @param mixed  $arg,... Optional. Additional arguments which are passed on to the
- *                        functions hooked to the action. Default empty.
  */
 function do_action($tag, $arg = '') {
 	global $wp_filter, $wp_actions, $wp_current_filter;
@@ -562,7 +559,7 @@ 
  *
  * @param string   $tag      The action to remove hooks from.
  * @param int|bool $priority The priority number to remove them from. Default false.
- * @return true True when finished.
+ * @return boolean True when finished.
  */
 function remove_all_actions($tag, $priority = false) {
 	return remove_all_filters($tag, $priority);
@@ -607,7 +604,7 @@ 
  * @see _deprecated_hook()
  *
  * @param string $tag         The name of the action hook.
- * @param array  $args        Array of additional function arguments to be passed to do_action().
+ * @param WP_Post[]  $args        Array of additional function arguments to be passed to do_action().
  * @param string $version     The version of WordPress that deprecated the hook.
  * @param string $replacement Optional. The hook that should have been used.
  * @param string $message     Optional. A message regarding the change.

src/wp-includes/pomo/translations.php

Doc Comments +3 added lines, -2 removed lines

@@ -72,6 +72,7 @@ 
 
 	/**
 	 * @param string $header
+	 * @return string
 	 */
 	function get_header($header) {
 		return isset($this->headers[$header])? $this->headers[$header] : false;
@@ -150,7 +151,7 @@ 
 	}
 
 	/**
-	 * @param object $other
+	 * @param Translations $other
 	 */
 	function merge_originals_with(&$other) {
 		foreach( $other->entries as $entry ) {
@@ -326,7 +327,7 @@ 
 	/**
 	 *
 	 * @param int $count
-	 * @return bool
+	 * @return integer
 	 */
 	function select_plural_form($count) {
 		return 1 == $count? 0 : 1;

src/wp-includes/post-template.php

Doc Comments +8 added lines, -8 removed lines

@@ -104,7 +104,7 @@ 
  *
  * @since 0.71
  *
- * @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 string
  */
 function get_the_title( $post = 0 ) {
@@ -169,7 +169,7 @@ 
  *
  * @since 1.5.0
  *
- * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
+ * @param integer $post Optional. Post ID or post object. Default is global $post.
  */
 function the_guid( $post = 0 ) {
 	$post = get_post( $post );
@@ -199,7 +199,7 @@ 
  *
  * @since 1.5.0
  *
- * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
+ * @param integer $post Optional. Post ID or post object. Default is global $post.
  * @return string
  */
 function get_the_guid( $post = 0 ) {
@@ -402,7 +402,7 @@ 
  *
  * @since 2.3.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.
  * @return bool True if the post has a custom excerpt, false otherwise.
  */
 function has_excerpt( $post = 0 ) {
@@ -1461,7 +1461,7 @@ 
  *
  * @since 2.0.0
  *
- * @param int|WP_Post $id Optional. Post ID or post object.
+ * @param integer $id Optional. Post ID or post object.
  * @param bool        $fullsize     Optional, default is false. Whether to use full size.
  * @param bool        $deprecated   Deprecated. Not used.
  * @param bool        $permalink    Optional, default is false. Whether to include permalink.
@@ -1482,7 +1482,7 @@ 
  * @since 2.5.0
  * @since 4.4.0 The `$id` parameter can now accept either a post ID or `WP_Post` object.
  *
- * @param int|WP_Post  $id        Optional. Post ID or post object.
+ * @param integer  $id        Optional. Post ID or post object.
  * @param string|array $size      Optional. Image size. Accepts any valid image size, or an array
  *                                of width and height values in pixels (in that order).
  *                                Default 'thumbnail'.
@@ -1592,7 +1592,7 @@ 
  *
  * @since 1.0.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.
  * @return string HTML content for password form for password protected post.
  */
 function get_the_password_form( $post = 0 ) {
@@ -1782,7 +1782,7 @@ 
  *
  * @since 2.6.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.
  * @param string      $type    'all' (default), 'revision' or 'autosave'
  */
 function wp_list_post_revisions( $post_id = 0, $type = 'all' ) {

src/wp-includes/post.php

Doc Comments +10 added lines, -10 removed lines

@@ -473,7 +473,7 @@ 
  * @since 1.0.0
  *
  * @param string $post Post content.
- * @return array Post before ('main'), after ('extended'), and custom read more ('more_text').
+ * @return integer Post before ('main'), after ('extended'), and custom read more ('more_text').
  */
 function get_extended( $post ) {
 	//Match the new style more links.
@@ -1362,7 +1362,7 @@ 
  *
  * @access private
  *
- * @param object|WP_Post_Type $post_type_object Post type object.
+ * @param WP_Post_Type|null $post_type_object Post type object.
  * @return object Object with all the labels as member variables.
  */
 function get_post_type_labels( $post_type_object ) {
@@ -1727,7 +1727,7 @@ 
  *
  * @param int    $post_id    Post ID.
  * @param string $meta_key   Metadata name.
- * @param mixed  $meta_value Optional. Metadata value. Must be serializable if
+ * @param string  $meta_value Optional. Metadata value. Must be serializable if
  *                           non-scalar. Default empty.
  * @return bool True on success, false on failure.
  */
@@ -2420,7 +2420,7 @@ 
  * @param int  $postid       Optional. Post ID. Default 0.
  * @param bool $force_delete Optional. Whether to bypass trash and force deletion.
  *                           Default false.
- * @return array|false|WP_Post False on failure.
+ * @return string False on failure.
  */
 function wp_delete_post( $postid = 0, $force_delete = false ) {
 	global $wpdb;
@@ -2678,7 +2678,7 @@ 
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param int|WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
+ * @param integer $post Optional. Post ID or post object. Defaults to global $post.
  * @return mixed|void False on failure.
  */
 function wp_trash_post_comments( $post = null ) {
@@ -2734,8 +2734,8 @@ 
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param int|WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
- * @return true|void
+ * @param integer $post Optional. Post ID or post object. Defaults to global $post.
+ * @return null|boolean
  */
 function wp_untrash_post_comments( $post = null ) {
 	global $wpdb;
@@ -4444,7 +4444,7 @@ 
  * @since 1.5.0
  * @since 4.6.0 Converted the `$page` parameter to optional.
  *
- * @param WP_Post|object|int $page Optional. Page ID or WP_Post object. Default is global $post.
+ * @param integer $page Optional. Page ID or WP_Post object. Default is global $post.
  * @return string|false Page URI, false on error.
  */
 function get_page_uri( $page = 0 ) {
@@ -5247,7 +5247,7 @@ 
  *
  * @since 2.1.0
  *
- * @param string|int $mime MIME type or attachment ID.
+ * @param integer $mime MIME type or attachment ID.
  * @return string|false Icon, false otherwise.
  */
 function wp_mime_type_icon( $mime = 0 ) {
@@ -6149,7 +6149,7 @@ 
  * @access private
  *
  * @param string $post_name Slug.
- * @param string $post_ID   Optional. Post ID that should be ignored. Default 0.
+ * @param integer $post_ID   Optional. Post ID that should be ignored. Default 0.
  */
 function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post_ID = 0 ) {
 	$trashed_posts_with_desired_slug = get_posts( array(

src/wp-includes/revision.php

Doc Comments +2 added lines, -2 removed lines

@@ -433,7 +433,7 @@ 
  *
  * @see get_children()
  *
- * @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`.
  * @param array|null  $args    Optional. Arguments for retrieving post revisions. Default null.
  * @return array An array of revisions, or an empty array if none.
  */
@@ -585,7 +585,7 @@ 
  * @since 4.6.0
  * @access private
  *
- * @param null|array|string $value    The value to return - a single metadata value, or an array of values.
+ * @param string $value    The value to return - a single metadata value, or an array of values.
  * @param int               $post_id  Post ID.
  * @param string            $meta_key Meta key.
  * @return null|array The default return value or the post thumbnail meta array.