Skip to content

Remove notices from other plugins on applications pages#2120

Merged
Crabcyborg merged 1 commit into
masterfrom
remove_notices_from_other_plugins_on_application_pages
Nov 19, 2024
Merged

Remove notices from other plugins on applications pages#2120
Crabcyborg merged 1 commit into
masterfrom
remove_notices_from_other_plugins_on_application_pages

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

No description provided.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 19, 2024

Walkthrough

The changes in this pull request focus on the FrmAppController class within FrmAppController.php. The in_our_pages method has been modified to enhance page context checks, now including conditions for specific admin pages and post types. Additionally, the filter_admin_notices method has been updated to leverage the improved in_our_pages method, ensuring that admin notices are filtered based on the current page context. These adjustments aim to refine the logic for determining relevant admin notices, contributing to a cleaner admin interface.

Changes

File Path Change Summary
classes/controllers/FrmAppController.php - Updated in_our_pages method to include checks for frm_logs, term.php, and edit-tags.php with taxonomy frm_application.
- Modified filter_admin_notices method to utilize the updated in_our_pages method for better context-aware filtering of admin notices.

Possibly related PRs

Suggested labels

action: needs qa

Warning

Rate limit exceeded

@Crabcyborg has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 41 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 44da5b9 and 6638215.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Copy Markdown
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

🧹 Outside diff range and nitpick comments (1)
classes/controllers/FrmAppController.php (1)

1367-1380: LGTM! Consider adding a constant for the taxonomy name.

The method correctly identifies Formidable admin pages by checking:

  1. Standard Formidable admin pages
  2. Logs post type pages
  3. Application taxonomy pages

Consider defining 'frm_application' as a class constant to avoid magic strings and improve maintainability:

+private const TAXONOMY_APPLICATION = 'frm_application';

private static function in_our_pages() {
  global $current_screen, $pagenow;
  if ( FrmAppHelper::is_formidable_admin() ) {
    return true;
  }

  if ( ! empty( $current_screen->post_type ) && 'frm_logs' === $current_screen->post_type ) {
    return true;
  }

  if ( in_array( $pagenow, array( 'term.php', 'edit-tags.php' ), true ) && 
-    'frm_application' === FrmAppHelper::simple_get( 'taxonomy' ) ) {
+    self::TAXONOMY_APPLICATION === FrmAppHelper::simple_get( 'taxonomy' ) ) {
    return true;
  }

  return false;
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 44da5b9 and 6638215.

📒 Files selected for processing (1)
  • classes/controllers/FrmAppController.php (1 hunks)
🔇 Additional comments (1)
classes/controllers/FrmAppController.php (1)

Line range hint 1381-1430: LGTM! Clean implementation of admin notice filtering.

The method effectively filters out third-party admin notices while preserving Formidable's own notices:

  1. Early return if not on Formidable pages
  2. Properly handles both function and class method callbacks
  3. Maintains Formidable notices by checking callback names

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 19, 2024

Walkthrough

The pull request modifies the FrmAppController class in FrmAppController.php, specifically enhancing the in_our_pages method to include detailed conditional checks for page context. This change improves the clarity and maintainability of the code. Additionally, the filter_admin_notices method is updated to leverage the new in_our_pages method, ensuring that admin notices are filtered appropriately based on the current page. Minor adjustments are made to global variable handling, particularly the introduction of $pagenow to support the new logic.

Changes

File Change Summary
classes/controllers/FrmAppController.php Enhanced in_our_pages method with detailed conditional checks; updated filter_admin_notices to use in_our_pages; introduced $pagenow for improved logic.

Possibly related PRs

Suggested labels

action: needs qa

Warning

Rate limit exceeded

@Crabcyborg has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 38 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 44da5b9 and 6638215.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Copy Markdown
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

🧹 Outside diff range and nitpick comments (2)
classes/controllers/FrmAppController.php (2)

1367-1380: LGTM! Consider extracting taxonomy check to a constant.

The enhanced page detection logic is well-structured and covers all necessary cases. The addition of the taxonomy check for 'frm_application' improves the functionality.

Consider extracting the taxonomy name to a class constant for better maintainability:

 class FrmAppController {
+    const APPLICATION_TAXONOMY = 'frm_application';
+
     // ... other code ...
     
     private static function in_our_pages() {
         global $current_screen, $pagenow;
         if ( FrmAppHelper::is_formidable_admin() ) {
             return true;
         }

         if ( ! empty( $current_screen->post_type ) && 'frm_logs' === $current_screen->post_type ) {
             return true;
         }

-        if ( in_array( $pagenow, array( 'term.php', 'edit-tags.php' ), true ) && 'frm_application' === FrmAppHelper::simple_get( 'taxonomy' ) ) {
+        if ( in_array( $pagenow, array( 'term.php', 'edit-tags.php' ), true ) && self::APPLICATION_TAXONOMY === FrmAppHelper::simple_get( 'taxonomy' ) ) {
             return true;
         }

         return false;
     }

Line range hint 1381-1424: Add error handling for edge cases.

The notice filtering logic is well-implemented but could be more robust.

Consider these improvements:

  1. Add null checks for $wp_filter[$action]:
     foreach ( $actions as $action ) {
+        if ( ! isset( $wp_filter[ $action ] ) ) {
+            continue;
+        }
         if ( empty( $wp_filter[ $action ]->callbacks ) ) {
             continue;
         }
  1. Add type checking for callback validation:
     private static function is_our_callback_array( $callback ) {
+        if ( ! is_array( $callback ) || ! isset( $callback['function'] ) ) {
+            return false;
+        }
         return ! empty( $callback['function'] ) &&
             is_array( $callback['function'] ) &&
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 44da5b9 and 6638215.

📒 Files selected for processing (1)
  • classes/controllers/FrmAppController.php (1 hunks)

@Crabcyborg Crabcyborg merged commit 8de1697 into master Nov 19, 2024
@Crabcyborg Crabcyborg deleted the remove_notices_from_other_plugins_on_application_pages branch November 19, 2024 18:32
@coderabbitai coderabbitai Bot mentioned this pull request Nov 26, 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.

1 participant