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

PCH: Initialize Content Helper features on 'rest_api_init' #2606

Merged
merged 2 commits into from
Jul 5, 2024

Conversation

vaurdan
Copy link
Contributor

@vaurdan vaurdan commented Jul 5, 2024

Description

This PR is a follow up of #2578. The Content Helper features also need to be initialized on rest_api_init, otherwise the custom post type and taxonomies for the Smart Linking feature will not be available in the REST API context.

Motivation and context

Fixes a bug where the Smart Linking /get endpoint does not return any smart links because the smart_link_source taxonomy does not exists.

How has this been tested?

Tested locally, and validated that the Smart Linking endpoint returns the expected results.

Summary by CodeRabbit

  • New Features
    • Integrated new functionality to enhance the REST API with the rest_api_init action, improving content management capabilities in the editor sidebar.

@vaurdan vaurdan added this to the 3.16.0 milestone Jul 5, 2024
@vaurdan vaurdan self-assigned this Jul 5, 2024
@vaurdan vaurdan requested a review from a team as a code owner July 5, 2024 08:36
Copy link
Contributor

coderabbitai bot commented Jul 5, 2024

Walkthrough

The new change introduces a rest_api_init action hook in the wp-parsely.php file to call the parsely_content_helper_editor_sidebar_features function. This enhancement extends the plugin’s functionalities to initialize during the REST API setup, potentially allowing for more dynamic interactions and seamless integration with the content editor sidebar.

Changes

Files Change Summary
wp-parsely.php Added rest_api_init action hook for invoking parsely_content_helper_editor_sidebar_features function during REST API setup.

Sequence Diagram(s)

sequenceDiagram
    participant W as WordPress
    participant P as wp-parsely.php
    participant F as parsely_content_helper_editor_sidebar_features
    
    W->>P: Initialize REST API
    P->>W: Add rest_api_init Hook
    W->>P: Execute rest_api_init Hook
    P->>F: Invoke parsely_content_helper_editor_sidebar_features
    F->>P: Functionality executed
    P->>W: REST API ready with extra features
Loading

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0d88cc3 and 8891706.

Files selected for processing (1)
  • wp-parsely.php (1 hunks)
Additional context used
Path-based instructions (1)
wp-parsely.php (1)

Pattern **/*.{html,php}: "Perform a detailed review of the provided code with following key aspects in mind:

  • Review the HTML and PHP code to ensure it is well-structured and adheres to best practices.
  • Ensure the code follows WordPress coding standards and is well-documented.
  • Confirm the code is secure and free from vulnerabilities.
  • Optimize the code for performance, removing any unnecessary elements.
  • Validate comments for accuracy, currency, and adherence to WordPress coding standards.
  • Ensure each line comment concludes with a period.
  • Verify code compatibility with the latest version of WordPress, avoiding deprecated functions or features."
Additional comments not posted (2)
wp-parsely.php (2)

290-290: Approve the addition of the rest_api_init action hook.

The addition ensures that the Content Helper features are initialized during the REST API initialization, which is necessary for making the custom post type and taxonomies available in the REST API context.


291-291: Approve the addition of the blank line for readability.

The blank line improves readability by separating the action hook from the subsequent comment block and function definition.

@acicovic
Copy link
Collaborator

acicovic commented Jul 5, 2024

Thanks for fixing this. Since we're now calling it in rest_api_init, do we also need the call inadmin_init?

@vaurdan
Copy link
Contributor Author

vaurdan commented Jul 5, 2024

@acicovic yeah, I believe so, so that the initialization also happens on wp-admin and not only just on the REST API.

@vaurdan vaurdan merged commit 94094d8 into develop Jul 5, 2024
36 checks passed
@vaurdan vaurdan deleted the update/fix-features-init branch July 5, 2024 11:26
@vaurdan vaurdan changed the title PCH: Initialize Content Helper features on rest_api_init PCH: Initialize Content Helper features on 'rest_api_init' Jul 8, 2024
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