GP Product Logs – User Guide

1. Introduction

GP Product Logs is a plugin designed to capture and display various log events in your WooCommerce store. It includes detailed stock changes, order status updates, and admin notes. You can filter logs by product, status, or custom notes. Plus, you can generate analytics to get a better understanding of your product trends.

2. Requirements & Installation

2.1. Requirements

• WordPress 5.0+ and WooCommerce active.
• PHP 7.2 or higher recommended.

2.2. Installation Steps

1. Upload or install GP Product Logs via Plugins > Add New.
2. Activate it from Plugins in WordPress admin.
3. On activation, the plugin creates a custom table (wp_gppl_saved_logs) and initializes default settings.
4. Go to Product Logs in the admin menu to start using the plugin.

3. Key Concepts

• Stock Changes: Automatically logged when product inventory adjusts (orders, manual edits, etc.).
• Status Logs: Tracks changes in WooCommerce order statuses.
• Notes: Additional admin or system notes that can appear in logs.
• Saved Logs: You can explicitly “Save” certain log entries to reference them more easily later.
• Analytics: Provides quick stats and charts (30-day sales, top sellers, low stock, etc.).

4. Basic Usage

4.1. Viewing Logs

1. In your WP Admin menu, click Product Logs.
2. By default, you’ll see a “Select Product(s)” screen or a quick “Select All” option.
3. After choosing products, you can view a combined log table that shows:
   • Stock logs (old quantity, new quantity, user, notes)
   • Status logs (old status, new status, user, optional order ID)
   • Notes logs (misc. notes about the product or order)
4. Use pagination, filters, and the search field to find specific log entries.
5. “Save” any log entries you want to keep pinned in Saved Logs.

Tip: You can reorder or refine your product selection at any time by going back to the “Change Products” button.

4.2. Saved Logs

1. Go to Product Logs > Saved Logs to see a list of entries that were explicitly saved.
2. Remove unwanted saves either individually or in bulk.
3. Use filters (product, log type, search) to find relevant saves quickly.

4.3. Analytics

1. Click Product Logs > Analytics to view an at-a-glance dashboard.
2. Includes overall 30-day sales, revenue, low stock listings, top sellers, and more.
3. Graphs (powered by Chart.js) display daily sales and stock distribution.
4. Optional: Add quick “analytics widgets” to the WP dashboard if enabled in the settings.

5. Settings & Advanced Usage

5.1. Plugin Settings

1. Access Product Logs > Settings.
2. Decide whether logs should appear in the product editor (via meta boxes).
3. Exclude specific products from logging entirely.
4. Configure Email Notifications for stock or status changes (or none).
5. Choose to display an analytics widget on the WP dashboard.

5.2. Meta Boxes in Product Editor

When enabled, you’ll see Stock Log, Status Log, and Notes Log sections under each product’s “Edit Product” screen in WordPress. This allows you to view the logs relevant to that single product quickly.

5.3. Shortcodes

GP Product Logs also includes shortcodes you can use in your site’s content to display analytics, charts, top sellers, and so on. For example:

• [gppl_30day_sales] – Shows total items sold in the last 30 days.
• [gppl_30day_revenue] – Shows total revenue over the last 30 days.
• [gppl_top_sellers] – Displays the top 5 best-selling products.
• [gppl_low_stock] – Lists products with stock between 1 and 49.
• [gppl_critical_stock] – Focuses on products with fewer than 5 in stock.
• [gppl_stock_distribution] – A doughnut chart showing how many products are at 0, 1–10, 11–50, etc.
• [gppl_sales_chart] – A line chart of daily sales over the last 30 days.
• [gppl_analytics_dashboard] – A full dashboard layout combining multiple widgets.

You can place these shortcodes on any WordPress page or post to share quick stats with your customers or internal team. For more info, check Product Logs > Help & Contact Us inside the plugin.

6. Uninstall & Conclusion

6.1. Uninstalling the Plugin

If you wish to remove GP Product Logs entirely:

1. Deactivate GP Product Logs from your WordPress Plugins page.
2. Click Delete to remove its files from your server.
3. If desired, manually remove leftover database tables or options (e.g., wp_gppl_saved_logs, gppl_plugin_settings).

6.2. Need Help?

If you encounter any problems or have questions, please email [email protected] or visit GoalPrevail.com for documentation and support.

Thank you for using GP Product Logs!