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: PHP Warning when trying to remove action dokan_seller_reg_form_fields #2285

Conversation

mralaminahamed
Copy link
Member

@mralaminahamed mralaminahamed commented May 29, 2024

All Submissions:

  • My code follow the WordPress' coding standards
  • My code satisfies feature requirements
  • My code is tested
  • My code passes the PHPCS tests
  • My code has proper inline documentation
  • I've included related pull request(s) (optional)
  • I've included developer documentation (optional)
  • I've added proper labels to this pull request

Changes proposed in this Pull Request:

Fix: PHP Warning when trying to remove action remove_action( 'woocommerce_register_form', 'dokan_seller_reg_form_fields' );

Related Pull Request(s)

  • Full PR Link

Closes

How to test the changes in this Pull Request:

  • Steps or issue link

Changelog entry

Fix: PHP Warning when trying to remove action remove_action( 'woocommerce_register_form', 'dokan_seller_reg_form_fields' );

Before Changes

Describe the issue before changes with screenshots(s).

After Changes

Describe the issue after changes with screenshot(s).

Feature Video (optional)

Link of detailed video if this PR is for a feature.

PR Self Review Checklist:

  • Code is not following code style guidelines
  • Bad naming: make sure you would understand your code if you read it a few months from now.
  • KISS: Keep it simple, Sweetie (not stupid!).
  • DRY: Don't Repeat Yourself.
  • Code that is not readable: too many nested 'if's are a bad sign.
  • Performance issues
  • Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
  • Grammar errors.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.
As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

  • Correct — Does the change do what it's supposed to? ie: code 100% fulfilling the requirements?
  • Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
  • Readable — Will your future self be able to understand this change months down the road?
  • Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

  • Bug Fixes
    • Improved registration validation to ensure the user role is not empty, enhancing data integrity during user registration.

…merce_register_form’, ‘dokan_seller_reg_form_fields’ ); `
@mralaminahamed mralaminahamed added Needs: Testing This requires further testing Needs: Dev Review It requires a developer review and approval labels May 29, 2024
@mralaminahamed mralaminahamed self-assigned this May 29, 2024
Copy link

coderabbitai bot commented May 29, 2024

Walkthrough

The validate_registration function in includes/Registration.php was updated to improve validation logic. The function now checks if the $_POST['role'] field is empty, in addition to verifying that the role is within the allowed roles array. This change ensures that a role must be selected during registration.

Changes

File Change Summary
includes/Registration.php Modified validate_registration to check if $_POST['role'] is empty in addition to role validation.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant RegistrationForm
    participant Registration

    User->>RegistrationForm: Fills registration form
    RegistrationForm->>Registration: Submits form with role
    Registration->>Registration: validate_registration()
    alt Role is empty or invalid
        Registration-->>RegistrationForm: Return error
    else Role is valid
        Registration-->>RegistrationForm: Proceed with registration
    end
Loading

Poem

In the fields where code does roam,
A role must find its rightful home.
No empty slots, no roles astray,
The registration's smooth today.
With checks so clear, the bugs do flee,
A happy coder, full of glee.
🌸🐇✨


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.

@mralaminahamed mralaminahamed added Need Dev Review Only and removed Needs: Testing This requires further testing Needs: Dev Review It requires a developer review and approval labels May 29, 2024
@mralaminahamed mralaminahamed requested review from shohag121 and removed request for MdAsifHossainNadim May 29, 2024 04:57
Copy link

@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)
includes/Registration.php (1)

Line range hint 148-149: Sanitize the input from $_POST['dokan_address'] and $_POST['phone'] to prevent security vulnerabilities.

- $dokan_settings['address'] = isset( $_POST['dokan_address'] ) ? wc_clean( wp_unslash( $_POST['dokan_address'] ) ) : '';
- $dokan_settings['phone'] = isset( $_POST['phone'] ) ? dokan_sanitize_phone_number( wp_unslash( $_POST['phone'] ) ) : '';
+ $dokan_settings['address'] = isset( $_POST['dokan_address'] ) ? sanitize_text_field( wp_unslash( $_POST['dokan_address'] ) ) : '';
+ $dokan_settings['phone'] = isset( $_POST['phone'] ) ? sanitize_text_field( wp_unslash( $_POST['phone'] ) ) : '';
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 485d1bc and ccfa51e.
Files selected for processing (1)
  • includes/Registration.php (1 hunks)
Additional Context Used
GitHub Check Runs (1)
Run PHPCS inspection failure (7)

includes/Registration.php: [failure] 148-148:
Detected usage of a non-sanitized input variable: $_POST['dokan_address']


includes/Registration.php: [failure] 149-149:
Detected usage of a non-sanitized input variable: $_POST['phone']

Additional comments not posted (2)
includes/Registration.php (2)

54-54: The added check for an empty role is a good enhancement for robustness.


Line range hint 148-149: The logic for checking and setting address profile completion is well-implemented.

@shohag121 shohag121 merged commit fd5dabd into getdokan:develop Jun 7, 2024
1 of 2 checks passed
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.

None yet

2 participants