README

This library provides developers to ask end user to review their product (theme / plugin)

Installation

The preferred way to install this extension is through Composer.

To install WP_Review_Me library, simply:

$ composer require Varunsridharan/WP_Review_Me

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Varunsridharan/WP_Review_Me --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/varunsridharan/wp-review-me.git

Or install it manually:

Download WP_Review_Me.php:

$ wget https://raw.githubusercontent.com/varunsridharan/wp-review-me/master/class-wp-review-me.php

Options

Option	Notes
`days_after`	Value should be in numbers
`slug`	Plugin Slug (Required)
`site`	Supported Sites : `wordpress` / `themeforest` / `codecanyon`
`item_id`	Item ID required if site is set-to `themeforest` / `codecanyon`
`type`	Set `plugin` or `theme` if site is set-to wordpress
`rating`	Set Int Val if site is set-to wordpress
`message`	Custom Message To Show In Admin
`link_label`	Review Button Label
`review_link`	You can override auto link generation by providing a link here
`notice_callback`	If you are using any admin notice handler / custom Library then you can provide a function to call when notice should be shown

Usage

Plugin / Theme From Wordpress.org

$review_instance = new Varunsridharan\WordPress\Review_Me(array(
    'days_after' => 2,
    'slug' => 'your-plugin',
    'type' => 'plugin', # Use theme if you are using it in a theme
    'site' => 'wordpress',
    'rating' => 3 # review link will have a default count of rating 3 which sets rating to 3 in review form
));

Plugin From Codecanyon.net

$review_instance = new Varunsridharan\WordPress\Review_Me(array(
    'days_after' => 2,
    'slug' => 'your-plugin',
    'site' => 'codecanyon',
    'item_id' => 'xxxxxxxx'
));

Theme From themeforest.net

$review_instance = new Varunsridharan\WordPress\Review_Me(array(
    'days_after' => 2,
    'slug' => 'your-plugin',
    'site' => 'themeforest',
    'item_id' => 'xxxxxxxx'
));

Custom Notice Callback

/**
 * $review_me is a instance of VS_WP_Review_Me Class
 */
function your_plugin_review_notice_add($review_me){
    // use your custom notice handle to add / display the notice
}

$review_instance = new Varunsridharan\WordPress\Review_Me(array(
    'days_after' => 2,
    'slug' => 'your-plugin',
    'type' => 'plugin', # Use theme if you are using it in a theme
    'site' => 'wordpress',
    'notice_callback' => 'your_plugin_review_notice_add'
));

Sample Output

📝 Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🤝 Contributing

If you would like to help, please take a look at the list of issues.

📜 License & Conduct

📣 Feedback

⭐ This repository if this project helped you! 😉
Create An 🔧 Issue if you need help / found a bug

💰 Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

☕ How about we get to know each other over coffee? Buy me a cup for just $9.99
☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
🔰 We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
🚀 Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

Connect & Say 👋

Follow me on 👨‍💻 Github and stay updated on free and open-source software
Follow me on 🐦 Twitter to get updates on my latest open source projects
Message me on 📠 Telegram
Follow my pet on Instagram for some dog-tastic updates!

Built With ♥ By Varun Sridharan

varunsridharan / wp-review-me

Maintainers

Details