Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add wp_version_compare function #7476

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

Debarghya-Banerjee
Copy link

Trac Ticket: Core-62151

Summary

  • This pull request introduces the wp_version_compare function to enhance version comparison capabilities in WordPress by allowing the option to ignore the patch version. This is particularly useful for compatibility checks where only major and minor versions are relevant, simplifying the process of validating plugin and theme compatibility with WordPress core.

Problem Statement

  • The existing version_compare() function in PHP compares the full version number, including the patch (third number). In many scenarios, such as plugin development, only the major and minor versions are necessary for determining compatibility. For example, a plugin tested with WordPress version 6.6 should also be compatible with 6.6.2, but the standard comparison would return false due to the patch difference.

Proposed Solution

  • The new wp_version_compare function provides:

    • Customizable Version Comparison: An option to ignore the patch version during comparisons, allowing developers to manage compatibility without altering API data.

    • Input Validation: Ensures that the provided versions are strings and that the comparison operator is valid, returning false for invalid parameters.

Benefits

  • Simplifies Compatibility Checks: By allowing developers to focus on major and minor version differences, the function enhances usability in compatibility scenarios.

  • Improved Validation: Robust input validation helps prevent errors, ensuring reliable comparisons.

Conclusion

  • This enhancement aligns with WordPress's goal of providing developers with powerful and flexible tools for managing version compatibility. By integrating the wp_version_compare function, we empower developers to streamline their workflows and reduce potential compatibility issues.

Copy link

github-actions bot commented Oct 1, 2024

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.

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

Props debarghyabanerjee.

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

Copy link

github-actions bot commented Oct 1, 2024

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.

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.

1 participant