REST API: remove unncessary local variables and reorders the expressions in `if` statements to optimize performance #7708

anton-vlasenko · 2024-11-01T19:07:55Z

remove unnecessary local variables;
reorder expressions in if statements to optimize performance;
fix issues with calling static methods dynamically and non-static methods statically;
merge isset() and unset() statements;
explicitly return null in WP_REST_Posts_Controller::handle_terms().

Trac ticket: https://core.trac.wordpress.org/ticket/62333

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

2. Reorders order of expressions in if statements to optimize performance. 3. Fixes issues with callling stating methods dynamically and non-static method statically. 4. Merges isset() and unset() statements. 5. Explicitly return null in WP_REST_Posts_Controller::handle_terms().

github-actions · 2024-11-01T19:20:11Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

github-actions · 2024-11-01T19:53:22Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @anton@antons-mac-mini.local.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

Core Committers: Use this line as a base for the props when committing in SVN:

Props antonvlasenko, mukesh27, apermo.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

mukeshpanchal27 · 2024-11-04T06:50:47Z

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

@@ -722,7 +721,7 @@ public function edit_media_item( $request ) {
 		$new_image_meta = wp_generate_attachment_metadata( $new_attachment_id, $saved['path'] );

 		// Copy the EXIF metadata from the original attachment if not generated for the edited image.
-		if ( isset( $image_meta['image_meta'] ) && isset( $new_image_meta['image_meta'] ) && is_array( $new_image_meta['image_meta'] ) ) {
+		if ( isset( $image_meta['image_meta'], $new_image_meta['image_meta'] ) && is_array( $new_image_meta['image_meta'] ) ) {


Core didn't use isset for two different variable.

Hi @mukeshpanchal27, thank you for your review!

Core didn't use isset for two different variables.

After double-checking, it looks like Core does sometimes use a single isset() statement for different variables. For example, you can find this approach in:

WP_Plugin_Install_List_Table::order_callback();

WP_REST_Menu_Items_Controller::prepare_items_query();

WP_Community_Events::coordinates_match();

parts of the Media Library code and other places.

I thought using a single isset() here could be a small optimization since it would prevent calling isset() multiple times. What do you think?

imho using a single isset (as well as unset) is fine. I wouldn't go that far calling it a performance optimization, but in my eyes it improves readability.

It's not a blocker if we go with a single isset. It's used in some places already, so there are no objections.

mukeshpanchal27 · 2024-11-04T06:51:27Z

Have you check the performance number before/after?

anton-vlasenko · 2024-11-06T20:26:57Z

Have you check the performance number before/after?

@mukeshpanchal27 I measured the performance improvement after you asked this question.
For example, in the widget controller, the improvement is about 0.6-1.5 microseconds per widget (of course, if certain conditions are met, and it depends greatly on the particular system).
The difference is measureable but minimal.
I expect similar results when measuring the effect that reordering conditional expressions in if statements brings to the other controllers in this PR.

apermo · 2024-11-08T13:48:47Z

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

@@ -722,7 +721,7 @@ public function edit_media_item( $request ) {
 		$new_image_meta = wp_generate_attachment_metadata( $new_attachment_id, $saved['path'] );

 		// Copy the EXIF metadata from the original attachment if not generated for the edited image.
-		if ( isset( $image_meta['image_meta'] ) && isset( $new_image_meta['image_meta'] ) && is_array( $new_image_meta['image_meta'] ) ) {
+		if ( isset( $image_meta['image_meta'], $new_image_meta['image_meta'] ) && is_array( $new_image_meta['image_meta'] ) ) {


imho using a single isset (as well as unset) is fine. I wouldn't go that far calling it a performance optimization, but in my eyes it improves readability.

apermo · 2024-11-08T13:48:50Z

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

@@ -418,7 +417,7 @@ public function create_post_autosave( $post_data, array $meta = array() ) {
 			$revision_id = _wp_put_post_revision( $post_data, true );
 		}

-		if ( is_wp_error( $revision_id ) || 0 === $revision_id ) {
+		if ( 0 === $revision_id || is_wp_error( $revision_id ) ) {


Nice, I like that reordering here. Good catch.

apermo · 2024-11-08T13:54:50Z

src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

-		}
-		return false;
+
+		return $taxonomy_obj && ! empty( $taxonomy_obj->show_in_rest );


While this is absolutely correct, the old one was easier to understand in my eyes. Not absolutely convinced here, but not against it either.

Maybe it just feels wrong when seeing them side by side.

src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

mukeshpanchal27 · 2024-11-11T11:41:21Z

src/wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

+		if ( ( 'network-active' === $current_status || 'network-active' === $new_status )
+			&& is_multisite()
+			&& ! current_user_can( 'manage_network_plugins' )
+		) {


Suggested change

if ( ( 'network-active' === $current_status || 'network-active' === $new_status )

&& is_multisite()

&& ! current_user_can( 'manage_network_plugins' )

) {

if (

( 'network-active' === $current_status || 'network-active' === $new_status ) &&

is_multisite() &&

! current_user_can( 'manage_network_plugins' )

) {

Similar to my finding, good catch!

Co-authored-by: Christoph Daum <c.daum@me.com>

This reverts commit de1dc28.

This reverts commit 3528076.

anton-vlasenko marked this pull request as ready for review November 1, 2024 19:53

mukeshpanchal27 reviewed Nov 4, 2024

View reviewed changes

anton-vlasenko requested a review from mukeshpanchal27 November 4, 2024 11:44

apermo suggested changes Nov 8, 2024

View reviewed changes

mukeshpanchal27 reviewed Nov 11, 2024

View reviewed changes

anton-vlasenko and others added 4 commits November 21, 2024 18:32

Fix CS.

de1dc28

Co-authored-by: Christoph Daum <c.daum@me.com>

Revert "Fix CS."

3528076

This reverts commit de1dc28.

Revert "Revert "Fix CS.""

8161306

This reverts commit 3528076.

Fix CS.

16b5f7e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

REST API: remove unncessary local variables and reorders the expressions in `if` statements to optimize performance #7708

REST API: remove unncessary local variables and reorders the expressions in `if` statements to optimize performance #7708

anton-vlasenko commented Nov 1, 2024 •

edited

Loading

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024 •

edited

Loading

mukeshpanchal27 Nov 4, 2024 •

edited

Loading

anton-vlasenko Nov 4, 2024 •

edited

Loading

apermo Nov 8, 2024

mukeshpanchal27 Nov 11, 2024

mukeshpanchal27 commented Nov 4, 2024

anton-vlasenko commented Nov 6, 2024 •

edited

Loading

apermo Nov 8, 2024

apermo Nov 8, 2024

apermo Nov 8, 2024

mukeshpanchal27 Nov 11, 2024

apermo Nov 11, 2024

REST API: remove unncessary local variables and reorders the expressions in if statements to optimize performance #7708

Are you sure you want to change the base?

REST API: remove unncessary local variables and reorders the expressions in if statements to optimize performance #7708

Conversation

anton-vlasenko commented Nov 1, 2024 • edited Loading

github-actions bot commented Nov 1, 2024

Test using WordPress Playground

Some things to be aware of

github-actions bot commented Nov 1, 2024 • edited Loading

Unlinked Accounts

mukeshpanchal27 Nov 4, 2024 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Nov 4, 2024 • edited Loading

Choose a reason for hiding this comment

apermo Nov 8, 2024

Choose a reason for hiding this comment

mukeshpanchal27 Nov 11, 2024

Choose a reason for hiding this comment

mukeshpanchal27 commented Nov 4, 2024

anton-vlasenko commented Nov 6, 2024 • edited Loading

apermo Nov 8, 2024

Choose a reason for hiding this comment

apermo Nov 8, 2024

Choose a reason for hiding this comment

apermo Nov 8, 2024

Choose a reason for hiding this comment

mukeshpanchal27 Nov 11, 2024

Choose a reason for hiding this comment

apermo Nov 11, 2024

Choose a reason for hiding this comment

REST API: remove unncessary local variables and reorders the expressions in `if` statements to optimize performance #7708

REST API: remove unncessary local variables and reorders the expressions in `if` statements to optimize performance #7708

anton-vlasenko commented Nov 1, 2024 •

edited

Loading

github-actions bot commented Nov 1, 2024 •

edited

Loading

mukeshpanchal27 Nov 4, 2024 •

edited

Loading

anton-vlasenko Nov 4, 2024 •

edited

Loading

anton-vlasenko commented Nov 6, 2024 •

edited

Loading