{"id":20140251,"url":"https://github.com/10quality/wpmvc-addon-reviewer","last_synced_at":"2026-05-12T10:31:11.370Z","repository":{"id":56937918,"uuid":"227433547","full_name":"10quality/wpmvc-addon-reviewer","owner":"10quality","description":"Lets you add a review plugin or theme notice in your project. Wordpress MVC Add-on.","archived":false,"fork":false,"pushed_at":"2019-12-13T20:17:41.000Z","size":29,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"v1.0","last_synced_at":"2025-01-13T10:13:57.149Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/10quality.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-11T18:29:45.000Z","updated_at":"2019-12-13T20:17:43.000Z","dependencies_parsed_at":"2022-08-21T06:50:21.010Z","dependency_job_id":null,"html_url":"https://github.com/10quality/wpmvc-addon-reviewer","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/10quality%2Fwpmvc-addon-reviewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/10quality%2Fwpmvc-addon-reviewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/10quality%2Fwpmvc-addon-reviewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/10quality%2Fwpmvc-addon-reviewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/10quality","download_url":"https://codeload.github.com/10quality/wpmvc-addon-reviewer/tar.gz/refs/heads/v1.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241583981,"owners_count":19986077,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T21:49:54.318Z","updated_at":"2026-05-12T10:31:06.333Z","avatar_url":"https://github.com/10quality.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Reviewer Addon (for Wordpress MVC)\n\n[![Latest Stable Version](https://poser.pugx.org/10quality/wpmvc-addon-reviewer/v/stable)](https://packagist.org/packages/10quality/wpmvc-addon-reviewer)\n[![Total Downloads](https://poser.pugx.org/10quality/wpmvc-addon-reviewer/downloads)](https://packagist.org/packages/10quality/wpmvc-addon-reviewer)\n[![License](https://poser.pugx.org/10quality/wpmvc-addon-reviewer/license)](https://packagist.org/packages/10quality/wpmvc-addon-reviewer)\n\n![Review notice](https://www.10quality.com/wp-content/uploads/2019/12/wpmvc-addon-reminder.jpg)\n\nAdd-on for [Wordpress MVC](http://wordpress-mvc.com/).\n\nThis addon will show a review notice to an admin user, suggesting them to review the plugin or theme.\n\nThe addon will manage responses and reminders to make the notice not as intrusive.\n\n## Install\n\nRun the following composer command at your project's root:\n\n```bash\ncomposer require 10quality/wpmvc-addon-reviewer\n```\n\n## Configuration\n\nAdd your project's root folder name inside the `paths` settings, like:\n\n```php\n    'paths' =\u003e [\n\n        'base'          =\u003e __DIR__ . '/../',\n        'controllers'   =\u003e __DIR__ . '/../Controllers/',\n        'views'         =\u003e __DIR__ . '/../../assets/views/',\n        'log'           =\u003e WP_CONTENT . '/wpmvc/log',\n        'root_folder'   =\u003e 'your-plugin-folder-name',\n\n    ],\n```\n\nThis will enable localization.\n\nAdd the following inside the `addons` settings:\n\n```php\n    'addons' =\u003e [\n        'WPMVC\\Addons\\Reviewer\\ReviewerAddon',\n    ],\n```\n\nThis will enable the addon files.\n\nAdd an extra `reviewer` settings:\n\n```php\n    'reviewer' =\u003e [\n\n        // Enables reviewer\n        'enabled'       =\u003e true,\n        // Name to display in notice\n        'name'          =\u003e 'Project name',\n        // Display interval in minutes\n        'interval'      =\u003e 43200,\n\n    ],\n```\n\n| Setting | Type | Description |\n| --- | --- | --- |\n| **enabled** | `bool` | Enables or disables the reviewer addon. |\n| **name** | `string` | Project name that will display inside the notice. |\n| **interval** | `int` | Interval in minutes. This is the time the addon will wait until the notice is displayed (for example 43200, will mean that it will display after 30 days). This interval is also used when the user selects to be reminded later. |\n| **url** | `string` | *OPTIONAL*, the review URL the addon will redirect the user to. If nothing is present, the addon will asume it is a Wordpress.org review and will build the url using the textdomain set in the `localize` settings. |\n\nSettings using a custom review url:\n\n```php\n    'reviewer' =\u003e [\n\n        // Enables reviewer\n        'enabled'       =\u003e true,\n        // Name to display in notice\n        'name'          =\u003e 'Project name',\n        // Display interval in minutes\n        'interval'      =\u003e 43200,\n        // Review url\n        'url'           =\u003e 'https://mydomain.com/my-product/review'\n\n    ],\n```\n\n## Wordpress Hooks\n\n### Filter:wpmvc_addon_reviewer_img_{namespace}\n\n`wpmvc_addon_reviewer_img_{namespace}`\n\nAllows to filter and replace the default `stars.svg` display in the notice, for the image of your choice.\n\nReplace **{namespace}** with your Wordpress MVC project's namespace (With caps).\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `$image_url` | `string` | Review image url. Recommended resolution (150px x 150px). |\n\nUsage example (namespace is *TestPlugin*):\n\n```php\nadd_filter( 'wpmvc_addon_reviewer_img_TestPlugin', function( $url ) {\n    // 150px x 150px\n    return 'https://www.domain.com/path-to/image.png';\n} );\n```\n\n## Coding Guidelines\n\nPSR-2 coding guidelines.\n\n# License\nGPLv3 License. (c) 2019 [10 Quality](https://www.10quality.com/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F10quality%2Fwpmvc-addon-reviewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F10quality%2Fwpmvc-addon-reviewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F10quality%2Fwpmvc-addon-reviewer/lists"}