gpi-inventory-shortcode.php: Deprecated snippet as functionality is now in GPI 1.0.

[veryspry]

Context

📓 Notion: https://www.notion.so/gravitywiz/GPI-1-0-1871242613d84640b0b5b189c64e9230?pvs=4

💬 GPI Changes: https://github.com/gravitywiz/gp-inventory/pull/118

Summary

Deprecates this snippet as the shortcode functionality is now in GPI 1.0.

[github-actions]

	Warnings
⚠️	When ready, don't forget to request reviews on this pull request from your fellow wizards.

Generated by 🚫 dangerJS against e8f91d2

[veryspry]

Leaving as draft until https://github.com/gravitywiz/gp-inventory/pull/118 is released

[coderabbitai]

Walkthrough

A deprecation warning comment was added at the beginning of the gp-inventory/gpi-inventory-shortcode.php file. No functional or code logic changes were made, and no exported or public entities were altered.

Changes

File(s)	Change Summary
gp-inventory/gpi-inventory-shortcode.php	Added a deprecation warning comment at the top.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

gp-inventory/gpi-inventory-shortcode.php (1)

3-4: Use a PHPDoc @deprecated annotation for clarity
The custom “WARNING! THIS SNIPPET IS DEPRECATED. 🚧” comment effectively signals deprecation, but adopting the standard @deprecated tag will improve IDE discovery and static-analysis support. For example:

- * WARNING! THIS SNIPPET IS DEPRECATED. 🚧
+ * @deprecated 1.0 Use the native GPI shortcode provided by Gravity Perks Inventory 1.0+
+ *             The old snippet will be removed in a future release.

Optionally, you can also emit a runtime deprecation notice:

@trigger_error(
    'The gpi_inventory_shortcode snippet is deprecated since GPI 1.0. Use the built-in shortcode instead.',
    E_USER_DEPRECATED
);

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c06034e and e8f91d2.

📒 Files selected for processing (1)

• gp-inventory/gpi-inventory-shortcode.php (1 hunks)