WordPress.org
Get WordPress

Plugin Directory

Changeset 3420119


Ignore:
Timestamp:
12/15/2025 12:28:35 PM (4 months ago)
Author:
optimum7
Message:

Update plugin name, readme, i18n and sanitization fixes

Location:
ffl-api/trunk
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • ffl-api/trunk/README.txt

    r3061052 r3420119  
    1 === FFL API WooCommerce Plugin ===
    2 Contributors: Optimum7
    3 Tags: FFL, WooCommerce, FFL gun dealers, gun dealer, FFL dealers
     1=== FFL API Integration for WooCommerce ===
     2Contributors: optimum7
     3Tags: ffl, woocommerce, firearms, gun dealers
    44Requires at least: 5.0
    5 Tested up to: 6.4
    6 Requires PHP: 7.3
    7 Stable tag: 1.6.1
     5Tested up to: 6.9
     6Requires PHP: 7.4
     7Stable tag: 1.0.1
    88License: GPLv3
    99License URI: https://www.gnu.org/licenses/gpl-3.0.html
    1010
    1111
    12 FFL API WooCommerce plugin has been created to improve WooCommerce online stores. It simplifies the checkout phase on online gun stores that can implement user-friendly features for the benefit to the dealers and their customers.
     12FFL API Integration for WooCommerce helps online stores integrate FFL dealer selection into the WooCommerce checkout process when selling regulated firearm products.
    1313
    1414
    1515== Description ==
    1616
     17FFL API Integration for WooCommerce is designed for WooCommerce-powered online stores that sell firearm-related products requiring shipment to licensed FFL dealers.
    1718
    18 [FFL API](https://www.fflapi.com) simplifies the checkout phase for online gun dealer websites. FFL API WooCommerce plugin only works on the websites that has WooCommerce plugin. These eCommerce stores can implement user-friendly features that benefit the dealers and their customers.
     19The plugin integrates with the FFL API service to allow customers to select a licensed dealer during checkout. This helps store owners clearly separate FFL and non-FFL products and guide customers through the appropriate checkout flow.
    1920
    20 
    21 As a one-of-a-kind software in the online gun dealer sector, FFL API provides a service that everybody needs in the process of buying FFL products online.
     21This plugin requires an active WooCommerce installation and valid API credentials from FFL API.
    2222
    2323
    2424== Shop Owners ==
    25 Online shop owners wish to raise revenue and improve their storefronts. 12% of customers leave the website during checkout because of the limited options or inconvenience. Others get upset with the brand in the case of never receiving their orders.
     25
     26Online shop owners selling regulated firearm products often need a clear and structured checkout experience that supports FFL dealer selection.
     27
     28This plugin provides tools to:
     29- Identify firearm products
     30- Display FFL dealer selection during checkout
     31- Manage dealer-related shipment details within WooCommerce
    2632
    2733
    28 With FFL API, shop owners will not lose customers on the checkout phase because of the confusion. Websites will see a drastic reduction in cart abandonment, and find viable business leads.
     34== Customers Purchasing FFL Products ==
    2935
     36Customers purchasing firearm products can search for nearby licensed FFL dealers by ZIP code during checkout and select a dealer before completing their order.
    3037
    31 == Users Interested In Purchasing FFL Products ==
    32 Website visitors want to shop online with ease. A complex checkout does not impress them, in the age of Amazon and convenience.
     38The selected dealer’s information is displayed clearly to help avoid confusion during fulfillment.
    3339
    34 
    35 FFL API provides user-friendly checkout. Visitors know whether their products are FFL or not and where to ship their products.
    3640
    3741== Screenshots ==
    3842
    39 1. Simply setup FFL API WooCommerce Plugin
    40 2. Set the products as firearms
    41 3. Bulk update the products
    42 4. FFL dealers appear on the map via zip code
    43 
    44 ==Features==
    45 
    46 ==User-Friendly Checkout==
    47 
    48 FFL API provides user-friendly checkout to WooCommerce stores. Customers can make their purchases easily, with an enhanced experience and simple UI design.
    49 
    50 ==Ability to Define FFL Products==
    51 
    52 FFL API WooCommerce plugin provides a very easy user interface for shop owners. As the admin of the online stores, shop owner adds FFL products to the store carts, which are saved in the system and appropriately defined. The API will remember these selections for future orders. Moreover, shop owner has the ability of bulk ordering as well.
    53 
    54 ==Bulk Update on Admin Panel==
    55 
    56 This feature provides the ability to determine the products as FFL or non-FFL with bulk edition on the admin panel. The store owners can update up to 999 products with one click.
    57 
    58 This feature also provides filtering of the products by category.
    59 
    60 ==Listing FFL Dealers On Map==
    61 
    62 FFL API saves customers the time spent finding their certified local dealers on a separate website. The software automatically lists the dealers within the customer’s zip code, eliminating one step of the purchase process. Thanks to this feature, store owners will not lose customers at the checkout phase and complete the conversion.
    63 
    64 ==Easy Gun Dealer Search With Zip Code==
    65 
    66 Customers have the ability to search with zip code and find the nearest gun dealer to them. They can select the gun dealer with just one click and continue to billing.
    67 
    68 ==Auto-Update Functionality==
    69 
    70 When a new release is published FFL API WooCommerce Plugin sends an update notification to the admin of the website. With this feature, the FFL API makes sure that websites are up to date.
    71 
    72 ==Color Customization==
    73 
    74 FFL API WooCommerce Plugin provides color customization ability to website admin. The plugin’s design can be determined however the admin wants.
     431. Plugin settings page
     442. Assigning products as firearms
     453. Bulk product management
     464. FFL dealer search by ZIP code
    7547
    7648
    77 ==The Ability to Land FFL Selection Area Anywhere on The Page==
     49== Features ==
    7850
    79 This feature provides the ability to set the position of FFL API Plugin where admin wants on the websites. There are 5 options for FFL API Plugin position:
     51= Checkout Integration =
     52Displays an FFL dealer search field on the WooCommerce checkout page when firearm products are present in the cart.
     53
     54= Firearm Product Identification =
     55Allows store administrators to mark products as firearm or non-firearm.
     56
     57= Bulk Product Updates =
     58Provides bulk actions in the admin panel to update firearm status for multiple products.
     59
     60= FFL Dealer Map =
     61Displays nearby licensed FFL dealers based on customer ZIP code using Google Maps.
     62
     63= Dealer Search by ZIP Code =
     64Customers can search for FFL dealers within a defined radius and select one during checkout.
     65
     66= Automatic Updates =
     67The plugin supports WordPress automatic update notifications.
     68
     69= Color Customization =
     70Admin users can adjust basic color settings for the FFL dealer list display.
     71
     72= Flexible Placement =
     73The FFL dealer selection area can be positioned in different locations on the checkout page:
    8074* Order Review
    8175* Above Billing Form
    … …  
    8478* Below Shipping Form
    8579
    86 ==Experience The FFL API Wordpress Plugin Before You Download==
     80
     81== Demo ==
     82You can view a demo of the plugin functionality here:
    8783[FFL API Demo](https://wpdemo.fflapi.com/)
    88 
    89 
    90 ###IMPORTANT:
    91 If you think you found a bug in  FFL API, or have a problem/question concerning the plugin, please check out [Support Forum](https://www.fflapi.com/contact-us/).
    92 
    93 ###IMPORTANT-2:
    94 If you don't have WooCommerce plugin on your website, FFL API will not work. FFL API WooCommerce Plugin has been created only to launch with WooCommerce plugin.
    95 
    96 
    97 
    9884
    9985
    10086== Frequently Asked Questions ==
    10187
     88= Can I use the same API key for multiple websites? =
     89No. Each website requires a separate API key.
    10290
    103 = 1. CAN I USE THE SAME API KEY FOR MULTIPLE WEBSITES? =
     91= Do unused API requests roll over to the next month? =
     92No. API request limits reset with each billing cycle.
    10493
    105 No. For each website, you need to have a unique API key. Therefore, you need to buy a unique one when integrating a new website.
     94= Can customers search dealers by address or ZIP code? =
     95Yes. Customers can search for licensed FFL dealers using ZIP code information.
    10696
    107 = 2. DOES THE API REQUEST NUMBERS TRANSFER TO THE NEXT MONTH'S USAGE? =
    108 
    109 No. Each package price is monthly. We provide an API request number for the purchased month.
    110 These numbers reset at the beginning of your package renewal date and do not transfer to the new month’s numbers.
    111 
    112 
    113 = 3. CAN CUSTOMERS MAKE AN ADDRESS SEARCH TO FIND GUN DEALERS? =
    114 
    115 Yes, customers can search for filling the address field to find the nearest gun dealers to the address.
    116 
    117 
    118 = 4. HOW DO I KNOW IF A GUN DEALER HAS FFL LICENSE OR NOT =
    119 
    120 
    121 FFL API, updates gun dealers according to the FFL license regularly.
    122 
     97= How is dealer license information maintained? =
     98FFL dealer data is updated through the FFL API service.
    12399
    124100
    125101== Installation ==
    126102
     103= Minimum Requirements =
     104* WordPress 5.0 or higher
     105* PHP 7.4 or higher
     106* MySQL 5.x
     107* WooCommerce plugin
    127108
    128 #### Thank you for your interest in FFL API WooCommerce Plugin.
     109= API Requirements =
     110To use this plugin, you need:
     1111. An FFL API key from https://app.fflapi.com/register
     1122. A Google Maps API key from https://developers.google.com/maps/documentation/maps-static/get-api-key
     113
     114= Installation Steps =
     1151. Upload the plugin ZIP file via Plugins > Add New > Upload Plugin
     1162. Activate the plugin
     1173. Navigate to the "FFL API" menu in the WordPress admin
     1184. Enter your API keys and configuration settings
     1195. Save changes
    129120
    130121
    131 ### Minimum requirements.
    132 *   Wordpress 5.0+
    133 *   PHP 7.x
    134 *   MySQL 5.x
    135 *   WooCommerce Plugin
    136 
    137 In order to use FFL Api, you need 2 API Keys
    138 1. FFL API: Please go to [https://app.fflapi.com/register](https://app.fflapi.com/register) and complete the subscription process.
    139 2. Google Maps API: You can see how to get Google Maps API Key from the link below.
    140 [https://developers.google.com/maps/documentation/maps-static/get-api-key](https://developers.google.com/maps/documentation/maps-static/get-api-key)
    141 
    142 You can follow the steps below for the setup process.
    143 
    144 ### Perform a new installation
     122== Assigning a Product as Firearm ==
     1231. Go to Products > All Products
     1242. Edit a product
     1253. Locate the firearm option in Product Data
     1264. Enable the firearm checkbox
     1275. Update the product
    145128
    146129
    147 After downloading the ZIP file of the Event Calendar WD plugin,
     130== How FFL Dealer Search Works ==
     1311. Add a firearm product to the cart
     1322. Proceed to checkout
     1333. Enter ZIP code in the FFL dealer search field
     1344. Select a dealer from the map or list
     1355. Complete checkout
    148136
    149137
    150 1. Log in to the administrator panel.
    151 2. Go to Plugins Add > New > Upload.
    152 3. Locate “ffl_WooCommerce_plugin.zip”
    153 4. Click "Install Now" button.
    154 5. Upon successful installation of the plugin, select “Activate Plugin” button
    155 6. After the plugin is activated,  “FFL API” will appear on the menu
    156 7. Select the “FFL API” link
    157 8. Fill in the following information:
    158 **FFL API Key
    159 **Google Maps API Key
    160 **Set Warning Message for the Checkout Page
    161 9. Select “Save Changes” to save the changes
    162 10. If the installation does not succeed, please [click here to contact us](https://www.fflapi.com/contact-us/).
     138== Changelog ==
    163139
     140= 1.6.2 =
     141* Plugin name and documentation updates to comply with WordPress.org guidelines
     142* Internationalization improvements
     143* Settings sanitization enhancements
    164144
    165 == How To Assign a Product as Firearm ==
    166 1. Navigate to “Products -> All Product”
    167 2. Select “Edit” button below the product title for the products that will be assigned as Firearm
    168 3. Scroll down to “Product Data” section
    169 4. Check “This is a firearm product” checkbox
    170 5. Select “Update” button.
     145= 1.6.1 =
     146* Compatibility update for WooCommerce HPOS
    171147
     148= 1.6.0 =
     149* Admin panel input hint improvements
    172150
    173 == How FFL Search Box Works ==
    174 1. Add a product that was assigned as a firearm in the cart
    175 2. Navigate to the Checkout
    176 3. FFL Dealer Search Box will appear
    177 4. Enter the Zipcode and the Radius information which FFL dealer you want the firearm to be shipped
    178 5. Select Find Nearby. Based on the Zipcode entered, FFL dealers located within the radius will appear on the map
    179 6. Select an FFL Dealer from the map. The shipping information of the selected FFL dealer will appear on the page
     151= 1.5.9 =
     152* Added option to control FFL info pop-up visibility
    180153
    181 == Changelog ==
    182 v1.6.1 Compatibility with Woocommerce HPOS
    183 v1.6.0 Admin panel input hint updates
    184 v1.5.9 Added FFL info pop-up visibility option
    185 v1.5.8 FFL map issue solved
    186 v1.5.7 Special character usage bug solved at Firearm Warning Message
    187 v1.5.6 some bug fixes
    188 v1.5.3 form clear notice added
    189 v1.5.2 Some UI fixes and improvements
    190 v1.5.1 WooCommerce 3.9+ Shipping Address issue fix
    191 v1.5.0 : First Offical Release!
     154= 1.5.8 =
     155* Fixed FFL dealer map display issue
     156
     157= 1.5.7 =
     158* Fixed special character handling in Firearm Warning Message
     159
     160= 1.5.6 =
     161* Minor bug fixes and stability improvements
     162
     163= 1.5.3 =
     164* Added form clear notice
     165
     166= 1.5.2 =
     167* User interface fixes and minor improvements
     168
     169= 1.5.1 =
     170* Fixed shipping address issue for WooCommerce 3.9 and later
     171
     172= 1.5.0 =
     173* Initial public release

  • ffl-api/trunk/admin/class-ffl-api-admin.php

    r2957890 r3420119  
    143143    {
    144144        //register our settings
    145         register_setting('ffl-api-settings', 'ffl_api_key_option');
    146         register_setting('ffl-api-settings', 'ffl_api_gmaps_option');
    147         register_setting('ffl-api-settings', 'ffl_api_warning_message');
    148         register_setting('ffl-api-settings', 'ffl_list_background_option');
    149         register_setting('ffl-api-settings', 'ffl_list_text_option');
    150         register_setting('ffl-api-settings', 'ffl_init_map_location');
    151         register_setting('ffl-api-settings', 'ffl_map_show_modal', ['default' => 'yes']);
     145        register_setting('ffl-api-settings','ffl_api_key_option',['type'=>'string','sanitize_callback'=>'sanitize_text_field']);
     146        register_setting('ffl-api-settings','ffl_api_gmaps_option',['type'=>'string','sanitize_callback'=>'sanitize_text_field']);
     147        register_setting('ffl-api-settings','ffl_api_warning_message',['type'=>'string','sanitize_callback'=>'sanitize_textarea_field']);
     148        register_setting('ffl-api-settings','ffl_list_background_option',['type'=>'string','sanitize_callback'=>'sanitize_hex_color']);
     149        register_setting('ffl-api-settings','ffl_list_text_option',['type'=>'string','sanitize_callback'=>'sanitize_hex_color']);
     150        register_setting('ffl-api-settings','ffl_init_map_location',['type'=>'string','sanitize_callback'=>'sanitize_text_field']);
     151        register_setting('ffl-api-settings','ffl_map_show_modal',['type'=>'string','default'=>'yes','sanitize_callback'=>'sanitize_text_field']);
     152
    152153    }
    153154

  • ffl-api/trunk/ffl-api.php

    r3061042 r3420119  
    1616 * Plugin Name:       FFl API
    1717 * Plugin URI:        fflapi.com
    18  * Description:       FFL API Woocommerce plugin
    19  * Version:           1.6.1
     18 * Description:       FFL API Integration for WooCommerce
     19 * Version:           1.6.2
    2020 * WC requires at least: 3.0.0
    2121 * WC tested up to:   6.1
    … …  
    4848 * Rename this for your plugin and update it as you release new versions.
    4949 */
    50 define('FFL_API_VERSION', '1.6.0');
     50define('FFL_API_VERSION', '1.6.2');
    5151
    5252/**

  • ffl-api/trunk/includes/class-ffl-api.php

    r2250737 r3420119  
    306306            _n('%s product set as firearm.',
    307307                '%s products set as firearm.',
    308                 intval($_REQUEST['set_ffl_done'])
     308                intval($_REQUEST['set_ffl_done']),
     309                'ffl-api'
    309310            ) . '</p></div>', intval($_REQUEST['set_ffl_done']));
    310311
    … …  
    318319            _n('%s product set as unfirearm.',
    319320                '%s products set as unfirearm.',
    320                 intval($_REQUEST['unset_ffl_done'])
     321                intval($_REQUEST['unset_ffl_done']),
     322                'ffl-api'
    321323            ) . '</p></div>', intval($_REQUEST['unset_ffl_done']));
    322324
Note: See TracChangeset for help on using the changeset viewer.