Skip to content

Add missing @since tags - #1974

Open
the-hercules wants to merge 2 commits into
developfrom
enhance/add-since-tags
Open

Add missing @since tags#1974
the-hercules wants to merge 2 commits into
developfrom
enhance/add-since-tags

Conversation

@the-hercules

Copy link
Copy Markdown

Closes #1526

Added @since annotations to various classes and methods across the codebase to indicate the version in which they were introduced or modified.

@rtBot rtBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code analysis identified issues

action-phpcs-code-review has identified potential problems in this pull request during automated scanning. We recommend reviewing the issues noted and that they are resolved.

phpcs scanning turned up:

⚠️ 1 warning


Powered by rtCamp's GitHub Actions Library

* @since 1.0.0
*/
public function add_bulk_actions_via_javascript() {
if ( ! current_user_can( $this->capability ) ) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Warning: Couldn't determine the value passed to the $capability parameter in function call to current_user_can(). Please check if it matches a valid capability. Found: $this->capability (WordPress.WP.Capabilities.Undetermined).

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Unrelated to this PR.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR improves API and internal code documentation by adding missing @since annotations across the GoDAM plugin, making it clearer when classes/methods/templates were introduced or changed (aligning with WordPress plugin documentation norms).

Changes:

  • Added @since tags to many PHP classes, traits, functions, and templates throughout the plugin.
  • Added @since tags to several REST API endpoint classes and methods to better document the public surface.
  • Included minor docblock touch-ups alongside the @since additions (e.g., plugin header / deactivation class header).

Reviewed changes

Copilot reviewed 102 out of 102 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
lib/class-godam-frappe-dispatch-installer.php Adds @since tags to installer client class and methods.
inc/traits/trait-singleton.php Adds @since tags to Singleton trait + members.
inc/templates/godam-video-gallery.php Adds @since tags to gallery template helpers.
inc/templates/godam-player.php Adds @since tag to player template header.
inc/helpers/custom-functions.php Adds @since tags to helper functions.
inc/helpers/class-api-key.php Adds @since tag to API key utility class docblock.
inc/helpers/autoloader.php Adds @since tags to autoloader header/function.
inc/classes/wpbakery-elements/class-wpb-godam-video.php Adds @since tags to WPBakery video element docs.
inc/classes/wpbakery-elements/class-wpb-godam-video-gallery.php Adds @since tag to WPBakery gallery element docs.
inc/classes/wpbakery-elements/class-wpb-godam-params.php Adds @since tag to WPBakery params docs.
inc/classes/wpbakery-elements/class-wpb-godam-audio.php Adds @since tag to WPBakery audio element docs.
inc/classes/taxonomies/class-media-folders.php Adds @since tags to taxonomy classes/methods.
inc/classes/taxonomies/class-base.php Adds @since tags to taxonomy base class/methods.
inc/classes/sureforms/class-init.php Adds @since tags to SureForms integration init.
inc/classes/sureforms/class-form-submit.php Adds @since tags to SureForms submit processing.
inc/classes/sureforms/class-assets.php Adds @since tags to SureForms assets handling.
inc/classes/sureforms/blocks/recorder/class-block.php Adds @since tags to SureForms recorder block class.
inc/classes/sureforms/blocks/class-register.php Adds @since tags to SureForms blocks register class.
inc/classes/shortcodes/class-godam-video-gallery.php Adds @since tags to gallery shortcode class/methods.
inc/classes/shortcodes/class-godam-player.php Adds @since tags to player shortcode class/methods.
inc/classes/shortcodes/class-godam-audio.php Adds @since tags to audio shortcode class/methods.
inc/classes/rest-api/class-wpforms.php Adds @since tags to WPForms REST endpoint docs.
inc/classes/rest-api/class-virtual-media-migration.php Adds @since tags to virtual media migration REST endpoint docs.
inc/classes/rest-api/class-video-sync.php Adds @since tags to video sync REST endpoint docs.
inc/classes/rest-api/class-video-migration.php Adds @since tags to video migration REST class constructor.
inc/classes/rest-api/class-transcoding.php Adds @since tags throughout transcoding REST endpoint class.
inc/classes/rest-api/class-sureforms.php Adds @since tags to SureForms REST endpoint methods.
inc/classes/rest-api/class-site.php Adds @since tags to site REST endpoint docs.
inc/classes/rest-api/class-settings.php Adds @since tags to settings REST endpoint docs.
inc/classes/rest-api/class-release-post.php Adds @since tags to release post REST endpoint docs.
inc/classes/rest-api/class-polls.php Adds @since tags to polls REST endpoint docs.
inc/classes/rest-api/class-meta-rest-fields.php Adds @since tags to meta REST fields class/methods.
inc/classes/rest-api/class-media-library.php Adds @since tags to media library REST endpoint methods.
inc/classes/rest-api/class-jetpack.php Adds @since tags to Jetpack REST endpoint methods (including helpers).
inc/classes/rest-api/class-gf.php Adds @since tags to Gravity Forms REST endpoint docs.
inc/classes/rest-api/class-forminator-forms.php Adds @since tags to Forminator REST endpoint docs.
inc/classes/rest-api/class-fluent-forms.php Adds @since tags to Fluent Forms REST endpoint docs.
inc/classes/rest-api/class-engagement.php Adds @since tags to engagement REST endpoint methods.
inc/classes/rest-api/class-dynamic-shortcode.php Adds @since tags to dynamic shortcode REST endpoint docs.
inc/classes/rest-api/class-dynamic-gallery.php Adds @since tags to dynamic gallery REST endpoint docs.
inc/classes/rest-api/class-cf7.php Adds @since tags to Contact Form 7 REST endpoint docs.
inc/classes/rest-api/class-base.php Adds @since tags to REST base class and key methods.
inc/classes/rest-api/class-analytics.php Adds @since tags to analytics REST endpoint methods.
inc/classes/rest-api/class-ads.php Adds @since tags to ads REST endpoint docs.
inc/classes/rest-api/class-addon-toggle.php Adds @since tags to addon toggle REST endpoint docs.
inc/classes/rest-api/class-addon-install.php Adds @since tags to addon install REST endpoint docs.
inc/classes/migrations/class-wpbakery-gallery-shortcode-v1-to-v2.php Adds @since tag to migration class header.
inc/classes/migrations/class-runner.php Adds @since tags to migrations runner docs.
inc/classes/migrations/class-godam-cpt-cleanup.php Adds @since tags to CPT cleanup migration docs.
inc/classes/migrations/class-gallery-v1-to-v2.php Adds @since tags to gallery v1→v2 migration docs.
inc/classes/migrations/class-elementor-gallery-widget-v1-to-v2.php Adds @since tags to Elementor widget migration docs.
inc/classes/media-library/class-media-edit-enhancements.php Adds @since tags to media edit enhancements docs.
inc/classes/lifter-lms/class-lifter-lms.php Adds @since tags to LifterLMS integration docs.
inc/classes/gravity-forms/class-init.php Adds @since tags to Gravity Forms integration docs.
inc/classes/gravity-forms/class-gf-field-godam-video.php Adds @since tags to GF custom field docs.
inc/classes/fluentforms/fields/class-recorder-field.php Adds @since tags to FluentForms recorder field docs.
inc/classes/fluentforms/class-init.php Adds @since tags to FluentForms integration init docs.
inc/classes/fluentforms/class-form-submit.php Adds @since tags to FluentForms submission docs.
inc/classes/everest-forms/class-everest-forms-field-godam-video.php Adds @since tag to Everest Forms field option doc.
inc/classes/enums/class-http-status-code.php Adds @since tags to HTTP status “enum” class docs.
inc/classes/enums/class-api-key-status.php Adds @since tags to API key status “enum” class docs.
inc/classes/elementor-widgets/class-godam-video.php Adds @since tags to Elementor video widget docs.
inc/classes/elementor-widgets/class-godam-gallery.php Adds @since tags to Elementor gallery widget docs.
inc/classes/elementor-widgets/class-godam-audio.php Adds @since tags to Elementor audio widget docs.
inc/classes/elementor-widgets/class-base.php Adds @since tags to Elementor widget base class docs.
inc/classes/elementor-controls/class-godam-media.php Adds @since tags to Elementor control docs.
inc/classes/cron-jobs/class-retranscode-failed-media.php Adds @since tags to retranscode cron job docs.
inc/classes/class-virtual-media-registrar.php Adds @since tags to virtual media registrar docs.
inc/classes/class-video-preview.php Adds @since tags to video preview class docs.
inc/classes/class-video-metadata.php Adds @since tags to video metadata class/method docs.
inc/classes/class-video-engagement.php Adds @since tags to video engagement class/method docs.
inc/classes/class-video-embed.php Adds @since tags to video embed class docs.
inc/classes/class-update.php Adds @since tags to update logic docs.
inc/classes/class-seo.php Adds @since tags throughout SEO integration docs.
inc/classes/class-plugin.php Adds @since tags to plugin manifest/loader docs.
inc/classes/class-pages.php Adds @since tags to admin pages controller docs.
inc/classes/class-media-tracker.php Adds @since tags to media tracker docs.
inc/classes/class-media-library-ajax.php Adds @since tags to media library AJAX controller docs.
inc/classes/class-filesystem.php Adds @since tags to filesystem helper docs.
inc/classes/class-embed.php Adds @since tags to embed integration docs.
inc/classes/class-elementor-widgets.php Adds @since tags to Elementor widgets loader docs.
inc/classes/class-deactivation.php Fixes a docblock typo and adds @since tags.
inc/classes/class-blocks.php Adds @since tags to blocks bootstrap docs.
inc/classes/class-assets.php Adds @since tags to assets bootstrap/docs.
inc/classes/assets/class-jetpack-form-assets.php Adds @since tags to Jetpack assets class docs.
inc/classes/assets/class-ima-assets.php Adds @since tags to IMA assets class docs.
inc/classes/addons/class-addon-registry.php Adds @since tags to add-on registry docs.
inc/classes/addons/class-abstract-addon.php Adds @since tags to add-on base API docs.
godam.php Adds @since tags to plugin header and lifecycle hooks.
assets/src/blocks/sureforms/blocks/recorder/render.php Adds @since tag to recorder block render template docs.
assets/src/blocks/godam-video-thumbnail/render.php Adds @since tag to thumbnail block render template docs.
assets/src/blocks/godam-video-duration/render.php Adds @since tag to duration block render template docs.
assets/src/blocks/godam-player/render.php Adds @since tag to player block render template docs.
assets/src/blocks/godam-pdf/render.php Adds @since tag to PDF block render template docs.
assets/src/blocks/godam-gallery-v2/render.php Adds @since tag to gallery v2 render template docs.
assets/src/blocks/godam-gallery-v2-item/render.php Adds @since tag to gallery v2 item render template docs.
assets/src/blocks/godam-audio/render.php Adds @since tag to audio block render template docs.
admin/godam-transcoder-functions.php Adds @since tags to admin transcoder helpers.
admin/godam-transcoder-actions.php Adds @since tags to transcoder admin actions.
admin/class-rtgodam-transcoder-rest-routes.php Adds @since tags to transcoder REST routes class/method docs.
admin/class-rtgodam-transcoder-admin.php Adds @since tags to transcoder admin notices/docs.
admin/class-rtgodam-retranscodemedia.php Adds @since tags to retranscode module docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread inc/classes/class-pages.php
Comment thread inc/classes/class-pages.php
Comment thread assets/src/blocks/sureforms/blocks/recorder/render.php
Comment thread inc/classes/class-video-preview.php
Comment thread inc/classes/rest-api/class-wpforms.php
Comment thread inc/classes/rest-api/class-cf7.php
Comment thread inc/classes/rest-api/class-ads.php
@github-actions

Copy link
Copy Markdown

🔍 WordPress Plugin Check Report

❌ Status: Failed

📊 Report

🎯 Total Issues ❌ Errors ⚠️ Warnings
18 2 16

❌ Errors (2)

📁 lib/class-godam-frappe-dispatch-installer.php (2 errors)
📍 Line 🔖 Check 💬 Message
318 PluginCheck.CodeAnalysis.WriteFile.PluginDirectoryWrite Plugin folders are deleted when upgraded. Do not save data to the plugin folder using unzip_file(). Detected usage of constant WP_PLUGIN_DIR. Use wp_upload_dir() to get the uploads directory path or save to the database instead.
363 PluginCheck.CodeAnalysis.WriteFile.PluginDirectoryWrite Plugin folders are deleted when upgraded. Do not save data to the plugin folder using copy_dir(). Detected usage of constant WP_PLUGIN_DIR. Use wp_upload_dir() to get the uploads directory path or save to the database instead.

⚠️ Warnings (16)

📁 composer.json (1 warning)
📍 Line 🔖 Check 💬 Message
0 missing_composer_json_file The "/vendor" directory using composer exists, but "composer.json" file is missing.
📁 readme.txt (2 warnings)
📍 Line 🔖 Check 💬 Message
0 mismatched_plugin_name Plugin name "GoDAM - Organize WordPress Media Library & File Manager with Unlimited Folders for Images, Videos & more" is different from the name declared in plugin header "GoDAM".
0 trademarked_term The plugin name includes a restricted term. Your chosen plugin name - "GoDAM - Organize WordPress Media Library & File Manager with Unlimited Folders for Images, Videos & more" - contains the restricted term "wordpress" which cannot be used at all in your plugin name.
📁 assets/build/blocks/godam-gallery-v2/render.php (2 warnings)
📍 Line 🔖 Check 💬 Message
17 WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound Global variables defined by a theme/plugin should start with the theme/plugin prefix. Found: "$inner_block_video_ids".
25 WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound Global variables defined by a theme/plugin should start with the theme/plugin prefix. Found: "$inner_block_video_ids".
📁 assets/build/css/main.css (1 warning)
📍 Line 🔖 Check 💬 Message
0 EnqueuedStylesScope This style is being loaded in all contexts.
📁 assets/src/libs/analytics.min.js (5 warnings)
📍 Line 🔖 Check 💬 Message
0 EnqueuedScriptsScope This script is being loaded in all frontend contexts.
0 NonBlockingScripts.NoStrategy This script on http://localhost:8880 (with handle analytics-library) is loaded in the footer. Consider a defer or async script loading strategy instead.
0 NonBlockingScripts.NoStrategy This script on http://localhost:8880/2026/06/20/hello-world/ (with handle analytics-library) is loaded in the footer. Consider a defer or async script loading strategy instead.
0 NonBlockingScripts.NoStrategy This script on http://localhost:8880/sample-page/ (with handle analytics-library) is loaded in the footer. Consider a defer or async script loading strategy instead.
0 NonBlockingScripts.NoStrategy This script on http://localhost:8880/demo-attachment-post/ (with handle analytics-library) is loaded in the footer. Consider a defer or async script loading strategy instead.
📁 assets/build/js/main.min.js (5 warnings)
📍 Line 🔖 Check 💬 Message
0 EnqueuedScriptsScope This script is being loaded in all frontend contexts.
0 NonBlockingScripts.NoStrategy This script on http://localhost:8880 (with handle rtgodam-script) is loaded in the footer. Consider a defer or async script loading strategy instead.
0 NonBlockingScripts.NoStrategy This script on http://localhost:8880/2026/06/20/hello-world/ (with handle rtgodam-script) is loaded in the footer. Consider a defer or async script loading strategy instead.
0 NonBlockingScripts.NoStrategy This script on http://localhost:8880/sample-page/ (with handle rtgodam-script) is loaded in the footer. Consider a defer or async script loading strategy instead.
0 NonBlockingScripts.NoStrategy This script on http://localhost:8880/demo-attachment-post/ (with handle rtgodam-script) is loaded in the footer. Consider a defer or async script loading strategy instead.

🤖 Generated by WordPress Plugin Check Action • Learn more about Plugin Check

@the-hercules
the-hercules requested a review from subodhr258 June 22, 2026 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants