Skip to content

Refactor: Extract wp_delete_inactive_widgets() for reuse in widget … - #12099

Open
pbearne wants to merge 16 commits into
WordPress:trunkfrom
pbearne:impove-wp_delete_inactive_widgets-routine
Open

Refactor: Extract wp_delete_inactive_widgets() for reuse in widget …#12099
pbearne wants to merge 16 commits into
WordPress:trunkfrom
pbearne:impove-wp_delete_inactive_widgets-routine

Conversation

@pbearne

@pbearne pbearne commented Jun 4, 2026

Copy link
Copy Markdown

…cleanup

clean the code in wp_ajax_delete_inactive_widgets

  • Trac ticket: https://core.trac.wordpress.org/ticket/65414

  • AI Disclosure:

    • AI assistance: Yes
    • Tool(s): Junie (JetBrains)
    • Model(s): gemini-3-flash-preview
    • Used for: Code analysis, test implementation, and workflow management.

@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown

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: @pbearne@git.wordpress.org.

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 pbearne, wildworks, mukesh27, westonruter.

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

@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown

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

  • 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.

Comment thread src/wp-admin/includes/widgets.php Outdated
Update version number in docblock for wp_delete_inactive_widgets function.

@westonruter westonruter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll be adding unit tests as part of this PR?

Comment thread src/wp-admin/includes/widgets.php Outdated
Comment thread src/wp-admin/includes/widgets.php Outdated
Comment thread src/wp-admin/includes/widgets.php Outdated

@t-hamano t-hamano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part also needs to be refactored by wp_delete_inactive_widgets().

foreach ( $sidebars_widgets['wp_inactive_widgets'] as $key => $widget_id ) {
$pieces = explode( '-', $widget_id );
$multi_number = array_pop( $pieces );
$id_base = implode( '-', $pieces );
$widget = get_option( 'widget_' . $id_base );
unset( $widget[ $multi_number ] );
update_option( 'widget_' . $id_base, $widget );
unset( $sidebars_widgets['wp_inactive_widgets'][ $key ] );
}

Additionally, unit tests are required.

Comment thread src/wp-admin/includes/widgets.php Outdated
@pbearne

pbearne commented Aug 11, 2026

Copy link
Copy Markdown
Author

Tests are here #12090

refactored widget form

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Refactors the logic for deleting inactive widgets by extracting it into a reusable helper, and then reusing that helper from both the classic Widgets screen form postback and the AJAX endpoint.

Changes:

  • Extracts inactive-widget deletion into new wp_delete_inactive_widgets() helper in the admin Widgets API.
  • Updates the non-JS classic widgets form handler to call the new helper.
  • Updates wp_ajax_delete_inactive_widgets() to call the new helper (and ensures the helper is loaded).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/wp-admin/widgets-form.php Replaces inline inactive widget deletion with wp_delete_inactive_widgets() in the non-JS flow.
src/wp-admin/includes/widgets.php Adds the new wp_delete_inactive_widgets() helper that removes inactive widgets and their settings.
src/wp-admin/includes/ajax-actions.php Uses wp_delete_inactive_widgets() for the AJAX “remove inactive widgets” handler.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/wp-admin/widgets-form.php
Comment thread src/wp-admin/includes/widgets.php
@t-hamano

Copy link
Copy Markdown
Contributor

Thank you for the update, @pbearne. Could you address the Copilot review? Additionally, could you add unit tests for the new wp_delete_inactive_widgets() function being introduced in this PR?

@pbearne

pbearne commented Aug 14, 2026

Copy link
Copy Markdown
Author

tests added

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants