Skip to content

PCH Smart Linking: Prevent suggesting links in unexpected blocks #2673

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.

Sign up for GitHub

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

Jump to bottom
Merged
vaurdan merged 8 commits into from
Jul 26, 2024
Merged

PCH Smart Linking: Prevent suggesting links in unexpected blocks #2673

vaurdan merged 8 commits into from
Jul 26, 2024

Conversation

@vaurdan
Copy link
Contributor

@vaurdan vaurdan commented Jul 26, 2024

Description

This PR is in response to the #2669, where we want to prevent Smart Links from being suggested in unexpected blocks, such as headings or captions.

It introduces a new constant BLOCKS_ALLOWED in the Smart_Linking class, which can be customized using the new wp_parsely_smart_linking_allowed_blocks filter. This allows developers to specify which blocks are eligible for Smart Linking. Here's an example of how developers can customize the allowed blocks for the Smart Linking feature:

function customize_smart_linking_allowed_blocks( $allowed_blocks ) {
    // Add custom blocks to the allowed list.
    $allowed_blocks[] = 'core/image';
    return $allowed_blocks;
}
add_filter( 'wp_parsely_smart_linking_allowed_blocks', 'customize_smart_linking_allowed_blocks' );

The Smart Linking UI was also updated to respect these allowed blocks, and a utility function isInsideHeadingOrCaption was added to skip applying links within headings or captions.

Motivation and context

How has this been tested?

Tested locally by verifying the filter for allowed blocks works as expected, ensuring Smart Links are not applied to inappropriate blocks or within headings or captions, and checking the UI for correct behavior with the new settings and adjustments.

Screenshots (if appropriate)

Screen.Recording.2024-07-26.at.13.43.34.mov

@vaurdan vaurdan added the Changelog: Fixed PR to be added under the changelog's "Fixed" section label Jul 26, 2024
@vaurdan vaurdan added this to the 3.16.2 milestone Jul 26, 2024
@vaurdan vaurdan self-assigned this Jul 26, 2024
@vaurdan vaurdan requested a review from a team as a code owner July 26, 2024 12:55
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 26, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Base branches to auto review (4)
  • develop
  • add/.*
  • fix/.*
  • update/.*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

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

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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration 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 mentioned this pull request Jul 26, 2024
Closed
This was linked to issues Jul 26, 2024
Smart Linking should not suggest links inside headings/captions #2669
Closed
PCH Smart Linking: Improve Classic Block handling #2619
Closed
@vaurdan vaurdan merged commit 3256a6b into prepare/3.16.2 Jul 26, 2024
@vaurdan vaurdan deleted the update/smart-linking-block-allowlist branch July 26, 2024 15:04
@vaurdan vaurdan mentioned this pull request Jul 30, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@acicovic acicovic acicovic approved these changes

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

@vaurdan vaurdan

Labels

Changelog: Fixed PR to be added under the changelog's "Fixed" section

Projects

None yet

Milestone

3.16.2

Development

Successfully merging this pull request may close these issues.

Smart Linking should not suggest links inside headings/captions PCH Smart Linking: Improve Classic Block handling

3 participants

@vaurdan @acicovic