vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Coding Standards: Restore more descriptive variable names in a few class methods.

Browse Source 
When various methods parameters in child classes were renamed to `$item` to match the parent class for PHP 8 named parameter support, most of the methods restored the more descriptive, specific name at the beginning for better readability, with several exceptions for methods consisting only of a few lines.

To avoid confusion about why some methods do that and some don't, this commit aims to bring more consistency to the code, specifically in list tables' `::column_default()` methods.

Follow-up to [51728], [51737], [51786].

See #58831.

git-svn-id: https://develop.svn.wordpress.org/trunk@56586 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2023-09-14 12:44:23 +00:00
parent 4ba29eb1cb
commit e005108fe1
30 changed files with 95 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php
View File

@@ -731,7 +731,8 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$post = $item;
$post = $item;
$response = parent::prepare_item_for_response( $post, $request );
$fields = $this->get_fields_for_response( $request );
$data = $response->get_data();

6
src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php
View File

@@ -409,10 +409,10 @@ class WP_REST_Autosaves_Controller extends WP_REST_Revisions_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$post = $item;
$response = $this->revisions_controller->prepare_item_for_response( $post, $request );
$post = $item;
$fields = $this->get_fields_for_response( $request );
$response = $this->revisions_controller->prepare_item_for_response( $post, $request );
$fields = $this->get_fields_for_response( $request );
if ( in_array( 'preview_link', $fields, true ) ) {
$parent_id = wp_is_post_autosave( $post );

5
src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php
View File

@@ -246,8 +246,9 @@ class WP_REST_Block_Types_Controller extends WP_REST_Controller {
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$block_type = $item;
$fields = $this->get_fields_for_response( $request );
$data = array();
$fields = $this->get_fields_for_response( $request );
$data = array();
if ( rest_is_field_included( 'attributes', $fields ) ) {
$data['attributes'] = $block_type->get_attributes();

5
src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
View File

@@ -1039,8 +1039,9 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$comment = $item;
$fields = $this->get_fields_for_response( $request );
$data = array();
$fields = $this->get_fields_for_response( $request );
$data = array();
if ( in_array( 'id', $fields, true ) ) {
$data['id'] = (int) $comment->comment_ID;

4
src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php
View File

@@ -367,8 +367,8 @@ class WP_REST_Global_Styles_Controller extends WP_REST_Controller {
}
// Base fields for every post.
$data = array();
$fields = $this->get_fields_for_response( $request );
$data = array();
if ( rest_is_field_included( 'id', $fields ) ) {
$data['id'] = $post->ID;
@@ -603,8 +603,8 @@ class WP_REST_Global_Styles_Controller extends WP_REST_Controller {
}
$theme = WP_Theme_JSON_Resolver::get_merged_data( 'theme' );
$data = array();
$fields = $this->get_fields_for_response( $request );
$data = array();
if ( rest_is_field_included( 'settings', $fields ) ) {
$data['settings'] = $theme->get_settings();

3
src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php
View File

@@ -168,7 +168,8 @@ class WP_REST_Menu_Locations_Controller extends WP_REST_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$location = $item;
$location = $item;
$locations = get_nav_menu_locations();
$menu = isset( $locations[ $location->name ] ) ? $locations[ $location->name ] : 0;

3
src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php
View File

@@ -193,7 +193,8 @@ class WP_REST_Pattern_Directory_Controller extends WP_REST_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$raw_pattern = $item;
$raw_pattern = $item;
$prepared_pattern = array(
'id' => absint( $raw_pattern->id ),
'title' => sanitize_text_field( $raw_pattern->title->rendered ),

1
src/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php
View File

@@ -222,6 +222,7 @@ class WP_REST_Post_Statuses_Controller extends WP_REST_Controller {
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$status = $item;
$fields = $this->get_fields_for_response( $request );
$data = array();

3
src/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php
View File

@@ -176,7 +176,8 @@ class WP_REST_Post_Types_Controller extends WP_REST_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$post_type = $item;
$post_type = $item;
$taxonomies = wp_list_filter( get_object_taxonomies( $post_type->name, 'objects' ), array( 'show_in_rest' => true ) );
$taxonomies = wp_list_pluck( $taxonomies, 'name' );
$base = ! empty( $post_type->rest_base ) ? $post_type->rest_base : $post_type->name;

3
src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
View File

@@ -1748,7 +1748,8 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$post = $item;
$post = $item;
$GLOBALS['post'] = $post;
setup_postdata( $post );

3
src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php
View File

@@ -547,7 +547,8 @@ class WP_REST_Revisions_Controller extends WP_REST_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$post = $item;
$post = $item;
$GLOBALS['post'] = $post;
setup_postdata( $post );

1
src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php
View File

@@ -195,6 +195,7 @@ class WP_REST_Search_Controller extends WP_REST_Controller {
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$item_id = $item;
$handler = $this->get_search_handler( $request );
if ( is_wp_error( $handler ) ) {
return new WP_REST_Response();

5
src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php
View File

@@ -320,8 +320,9 @@ class WP_REST_Sidebars_Controller extends WP_REST_Controller {
// Restores the more descriptive, specific name for use within this method.
$raw_sidebar = $item;
$id = $raw_sidebar['id'];
$sidebar = array( 'id' => $id );
$id = $raw_sidebar['id'];
$sidebar = array( 'id' => $id );
if ( isset( $wp_registered_sidebars[ $id ] ) ) {
$registered_sidebar = $wp_registered_sidebars[ $id ];

3
src/wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php
View File

@@ -209,7 +209,8 @@ class WP_REST_Taxonomies_Controller extends WP_REST_Controller {
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$taxonomy = $item;
$base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
$base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
$fields = $this->get_fields_for_response( $request );
$data = array();

5
src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php
View File

@@ -231,9 +231,10 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$theme = $item;
$data = array();
$theme = $item;
$fields = $this->get_fields_for_response( $request );
$data = array();
if ( rest_is_field_included( 'stylesheet', $fields ) ) {
$data['stylesheet'] = $theme->get_stylesheet();

5
src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php
View File

@@ -984,9 +984,10 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
*/
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$user = $item;
$data = array();
$user = $item;
$fields = $this->get_fields_for_response( $request );
$data = array();
if ( in_array( 'id', $fields, true ) ) {
$data['id'] = $user->ID;

5
src/wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php
View File

@@ -297,8 +297,9 @@ class WP_REST_Widget_Types_Controller extends WP_REST_Controller {
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$widget_type = $item;
$fields = $this->get_fields_for_response( $request );
$data = array(
$fields = $this->get_fields_for_response( $request );
$data = array(
'id' => $widget_type['id'],
);