Scrutinizer in 4.1

[wonderboymusic]

Low-hanging fruit cleanup based on Scrutinizer output:

​https://scrutinizer-ci.com/g/staylor/WordPress/inspections/afebe059-8bf7-4132-8b77-514db7ee2582

[wonderboymusic]

In 30136:

In Custom_Image_Header->step_2(), $type is set internally but never used.

See #30224.

[wonderboymusic]

In 30137:

In wp_xmlrpc_server->_prepare_comment(), $comment_date is set internally but never used.

See #30224.

[wonderboymusic]

In 30138:

In wp_xmlrpc_server methods, don't set $blog_id internally if it is never used, which is almost always. Updates the docs.

See #30224.

[wonderboymusic]

In 30139:

In wp_xmlrpc_server->pingback_ping(), remove the internal variable $way each time it is set and not used.

See #30224.

[wonderboymusic]

In 30153:

In wp_xmlrpc_server methods, for comprehensibility:

• initialize arrays in loops, instead of overriding an uninitialized array each time
• in ->blogger_getRecentPosts() and ->mw_getRecentPosts(), remove the extra loops by only setting one array

See #30224.

[wonderboymusic]

In 30154:

In WP_List_Table, add a property, $modes, to allow WP_Media_List_Table to inherit ->view_switcher().

See #30224.

[wonderboymusic]

Fixed 91 issues so far, this is the latest run after @markjaquith re-sync'd Git repo:
​https://scrutinizer-ci.com/g/staylor/WordPress/inspections/c68e0913-d1dd-4dfd-bdcf-5b2dc68e0f3c

[wonderboymusic]

In 30162:

In _wp_json_convert_string(), when $use_mb is false, perhaps pass a variable that actually exists to wp_check_invalid_utf8().

Introduced in [30055].
See #30224.

[wonderboymusic]

In 30163:

In WP_Meta_Query->get_sql_for_clause(), the empty initialization of $where is dead code and can be removed.

See #30224.

[wonderboymusic]

In 30164:

In customize.php, check that $autofocus is an array after running wp_unslash() instead of before. This is admittedly to skip a traversable hint in Scrutinizer.

See #30224.

[wonderboymusic]

In 30165:

Make the docs type for return in wpmu_create_user() more specific.

See #30224.

[wonderboymusic]

In 30166:

In get_the_pagination(), don't pass $links to _navigation_markup() if it is not a string - paginate_links() can return an array.

See #30224.

[wonderboymusic]

In 30167:

In wp_ajax_ajax_tag_search(), bail immediately if $_GET['tax'] isn't set so that all of the variable setting can happen in the same nest scope as the rest of the function - wp_die() confuses Scrutinizer.

See #30224.

[wonderboymusic]

In 30168:

In wp_ajax_get_tagcloud(), bail immediately if $_POST['tax'] isn't set so that all of the variable setting can happen in the same nest scope as the rest of the function - wp_die() confuses Scrutinizer.

See #30224.

[wonderboymusic]

In 30169:

Fix the return value doc for WP_List_Table->get_pagination_arg().

See #30224.

[wonderboymusic]

In 30170:

Declare the $options property for WP_Upgrader_Skin.

See #30224.

[wonderboymusic]

In 30171:

Declare the $update_count and $update_current properties for WP_Upgrader.

See #30224.

[wonderboymusic]

In 30172:

Declare the $uploaded_headers and $default_headers properties for WP_Customize_Header_Image_Control.

See #30224.

[wonderboymusic]

In 30173:

In _WP_Editors::editor_settings(), $str1 and $str2 don't need to be initialized empty.

See #30224.

[wonderboymusic]

In 30178:

Fix the return docs for WP_Embed->maybe_make_link().

See #30224.

[wonderboymusic]

In 30179:

In WP_HTTP_IXR_Client:

• declare $scheme as a property, it doesn't exist on the parent class
• declare $error as a property of type IXR_Error, instead of it being inferred as boolean from the parent class

See #30224.

[wonderboymusic]

In 30180:

WP_Image_Editor_GD and WP_Image_Editor_Imagick should specify type in a doc block for the $image property, instead of inferring bool and null.

See #30224.

[wonderboymusic]

In 30181:

Almost every method in wp_xmlrpc_server can also return IXR_Error and should be labeled as such. Rehabilitate some return syntax.

See #30224.

[wonderboymusic]

In 30182:

In WP_Comment_Query, declare $query_vars and $comments as properties.

See #30224.

[wonderboymusic]

In 30183:

In WP_Locale, declare $number_format as a property.

See #30224.

[wonderboymusic]

In 30184:

In WP_Tax_Query, declare $primary_table and $primary_id_column as properties.

See #30224.

[wonderboymusic]

Fixed 214 issues since the last run:
​https://scrutinizer-ci.com/g/staylor/WordPress/inspections/1a9884dd-5688-4433-80f3-64ecf1ddf680

[wonderboymusic]

In 30186:

In Custom_Background, declare $updated as a property.

See #30224.

[wonderboymusic]

In 30187:

In Custom_Image_Header:

• In ->process_default_headers(), remove check on non-existent $headers property. Introduced in [13403].
• Declare $updated as a property.

See #30224.

[wonderboymusic]

In 30188:

Correct the return value doc block for get_theme_support().

See #30224.

[wonderboymusic]

In 30189:

Correct type in the doc block for get_theme_support().

See #30224.

[wonderboymusic]

In 30190:

Fill in types for the @params for wp_comment_reply().

See #30224.

[wonderboymusic]

In 30191:

Correct the @param type for the $query arg for remove_query_arg().

See #30224.

[wonderboymusic]

In 30192:

Fill in the @param types for the args in WP_Text_Diff_Renderer_Table->interleave_changed_lines().

See #30224.

[wonderboymusic]

In 30193:

Fill in the @param types for the args for dbDelta().

See #30224.

[wonderboymusic]

In 30195:

Fill in the @param types for the args for make_site_theme_from_default().

See #30224.

[wonderboymusic]

In 30196:

Fill in the @param types for the args for functions missing them in wp-admin/includes/template.php.

See #30224.

[wonderboymusic]

In 30197:

Fill in the @param types for the args for functions missing them in wp-admin/includes/taxonomy.php.

See #30224.

[wonderboymusic]

In 30198:

Fill in the @param types for the args for functions missing them in wp-admin/includes/post.php.

See #30224.

[wonderboymusic]

In 30199:

Fill in the @param types for the args for functions missing them in wp-admin/includes/plugin.php.

See #30224.

[wonderboymusic]

In 30200:

Fill in the @param types for the args for functions missing them in wp-admin/includes/misc.php.

See #30224.

[wonderboymusic]

In 30201:

Fill in the @param types for the args for functions missing them in wp-admin/includes/deprecated.php (pour one out).

See #30224.

[wonderboymusic]

In 30202:

Correct all @return unknown instances.

See #30224.

[wonderboymusic]

In 30203:

Correct some types in wp-admin/*-location files' doc blocks.

See #30224.

[wonderboymusic]

Fixed 99 more issues:
​https://scrutinizer-ci.com/g/staylor/WordPress/inspections/9965ddf6-05a8-462b-8560-bcc0ecdb6715

[DrewAPicture]

In 30225:

Add parameter and return descriptions to the WP_List_Table::get_pagination_arg() DocBlock.

See #30224.

[DrewAPicture]

In 30226:

Merge a multi-line comment into a single-line comment in wp-includes/link-template.php.

See [30166]. See #30224.

[ocean90]

Closing as fixed for 4.1.

[wonderboymusic]

Some more @param cleanup

[wonderboymusic]

In 30662:

Improve the @param docs for trackback_response() and validate_another_blog_signup().

See #30224.

[wonderboymusic]

In 30663:

Add missing @params to src/wp-includes/pomo files.

See #30224.

[wonderboymusic]

In 30664:

Improve the @param docs for src/wp-includes/wp-db.php.

See #30224.

[wonderboymusic]

In 30665:

Improve the @param docs for src/wp-includes/widgets.php.

See #30224.

[wonderboymusic]

In 30666:

Improve the @param docs for src/wp-includes/user.php.

See #30224.

[wonderboymusic]

In 30667:

Improve the @param docs for src/wp-includes/pluggable*.

See #30224.

[wonderboymusic]

In 30668:

Improve the @param docs for src/wp-admin/includes/plugin.php.

See #30224.

[wonderboymusic]

In 30669:

Improve the @param docs for src/includes/rewrite.php.

See #30224.

[wonderboymusic]

In 30671:

Improve the @param docs for src/wp-includes/post*.php.

See #30224.

[wonderboymusic]

In 30672:

Improve the @param docs for src/includes/theme.php and src/includes/update.php.

See #30224.

[wonderboymusic]

In 30673:

Improve various @param docs.

See #30224.

[wonderboymusic]

In 30674:

Improve various @param docs.

See #30224.

[wonderboymusic]

In 30676:

Improve various @param docs for src/wp-includes/class-wp-customize*.php.

See #30224.

[wonderboymusic]

In 30678:

Improve various @param docs for src/wp-admin/includes/class-wp-filesystem-*.php.

See #30224.

[wonderboymusic]

In 30680:

Improve various @param docs for src/wp-admin/*.

See #30224.

[wonderboymusic]

In 30681:

Improve various @param docs for src/wp-includes/*.

See #30224.

[wonderboymusic]

That was super annoying but will get rid of 200-300 Scrutinizer notices.

Updating the config to ignore 3rd-party libraries got rid of 941 errors:
​https://scrutinizer-ci.com/g/staylor/WordPress/inspections/15a201ed-c88d-4fe4-a8bc-54b8a0cc8859

[wonderboymusic]

In 30682:

Improve various @param docs.

See #30224.

[johnbillion]

Anything left to do here?

[wonderboymusic]

Done for now

[SergeyBiryukov]

In 31108:

Correct @return value for WP_Theme::load_textdomain() after [30681].

see #30224.

[SergeyBiryukov]

In 31279:

Fix a typo in [30138].

see #30224.

[DrewAPicture]

In 32554:

Add a proper description comment for the WP_Image_Editor_GD->$image property.

See [30180]. See #30224.

[DrewAPicture]

In 32555:

Add a proper description comment for the WP_Image_Editor_Imagick->$image property.

See [30180]. See #30224.

[DrewAPicture]

In 32556:

Add proper descriptions for the $methods, $blog_options, and $error properties in wp_xmlrpc_server.

See [30181]. See #30224.

[DrewAPicture]

In 32557:

Add a proper return description for the wp_xmlrpc_server->addTwoNumbers() method.

See [30181]. See #30224.

[DrewAPicture]

In 32558:

Properly notate the inline link to the xmlrpc_blog_options filter in the description for wp_xmlrpc_server->initialise_blog_option_info().

See #30224.

[DrewAPicture]

In 34489:

Docs: Add a summary, version, and @access tag to the property DocBlock for WP_Locale->number_format.

See [5308] for where the property was initially introduced.
See [31083] for where the property was actually declared.

Props brentvr.
See #30224. See #32246.

[DrewAPicture]

In 34490:

Docs: Add a summary, version, and @access tag to the property DocBlock for Custom_Background->updated.

See [13765] for where the property was initially introduced.
See [30186] for where the property was actually declared.

Props brentvr.
See #30224. See #32246.

[DrewAPicture]

In 34491:

Docs: Add a summary, version, and @access tag to the property DocBlock for Custom_Image_Header->updated.

See [14907] for where the property was initially introduced.
See [30187] for where the property was actually declared.

Props brentvr.
See #30224. See #32246.

[DrewAPicture]

@brentvr: Thanks for the patches. Keep them coming!

See [34489], [34490], and [34491], which cover R30183.diff​, R30186.diff​, and R30187.diff​, respectively.

[welcher]

Found a couple of small formatting issues when looking at [30671]

[DrewAPicture]

In 34768:

Docs: Fix a few syntatical issues with inline documentation in wp-includes/post-template.php.

Props welcher.
See #30224.