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

Fix removeEditorPanel() deprecation message in WordPress 6.5 #2398

Merged

Conversation

acicovic
Copy link
Collaborator

@acicovic acicovic commented Apr 18, 2024

Description

In the PCH Excerpt Generator, we were using dispatch( 'core/edit-post' ).removeEditorPanel( 'post-excerpt' ) which is now deprecated in favor of dispatch( 'core/editor' ).removeEditorPanel( 'post-excerpt' ) on WordPress 6.5 and newer.

This PR allows WordPress 6.5 to use the new code, and keeps the legacy code for older WordPress versions. Unfortunately, a couple of // ts-ignore comments needed to be added to stop TypeScript from complaining and failing builds.

Motivation and context

Resolve deprecation messages while keeping backward compatibility.

How has this been tested?

  • Existing tests pass.
  • Manually tested that the correct code is being triggered depending on the WordPress version (tested with WordPress 6.5.2 and 6.4.4).

Summary by CodeRabbit

  • Bug Fixes
    • Improved the removal process of the excerpt panel in the WordPress editor to handle deprecations in WordPress 6.5 effectively.

Copy link
Contributor

coderabbitai bot commented Apr 18, 2024

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (2)
  • build/content-helper/excerpt-generator.asset.php is excluded by !build/**
  • build/content-helper/excerpt-generator.js is excluded by !build/**

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The update modifies the excerpt panel removal process in a WordPress editor by incorporating a conditional check. This enhancement ensures compatibility with the deprecation changes introduced in WordPress 6.5, improving the reliability and future-proofing of the feature.

Changes

File Path Change Summary
src/.../excerpt-generator/excerpt-generator.tsx Adjusted dispatch action for removing the excerpt panel with a conditional check for WordPress 6.5.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@acicovic acicovic marked this pull request as ready for review April 18, 2024 08:55
@acicovic acicovic requested a review from a team as a code owner April 18, 2024 08:55
Copy link
Contributor

@vaurdan vaurdan left a comment

Choose a reason for hiding this comment

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

Thank you! Added a question, but still approved!

@acicovic acicovic merged commit e460312 into develop Apr 18, 2024
36 checks passed
@acicovic acicovic deleted the fix/edit-post-remove-editor-panel-deprecation-in-wp-6.5 branch April 18, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants