Here’s how you can structure your README.md
file, including your author information and social media links:
This plugin provides several custom hooks for managing queries, settings, and CSV data in a WordPress environment. Below is a detailed description of each hook and its functionality. Some of the most popular WordPress themes like Astra, Divi, OceanWP, GeneratePress, Neve, Hestia, Avada, Sydney, Zakra, and Twenty Twenty-One etc. could works with it perfectly along with your custom theme too!
- Description: Deletes a query form.
- Location: Inside the
page=reply_edit_remove
page. - Functionality: Removes a specific query from the system.
- Description: Updates an existing query.
- Location: Inside the
page=reply_edit_remove
page. - Functionality: Modifies the details of an existing query.
- Description: Fetches data from the Summernote editor, along with query and tags data, to populate the update form.
- Location: Inside the
page=reply_edit_remove
page. - Functionality: Retrieves relevant data for a specific query, allowing for updates with the fetched data.
- Description: Saves a query, along with its response and associated tags.
- Location: Inside the
page=reply_edit_remove
page. - Functionality: Stores the query and its related data in the database.
- Description: Saves global chat settings into the database.
- Location: Inside the settings form.
- Functionality: Updates and stores global settings for the chat functionality.
- Description: Displays the current settings values inside the settings form.
- Location: Inside the settings form.
- Functionality: Fetches and displays saved settings for user review and updates.
- Description: Imports data from a CSV file into the
wp_chats
table. - Location: In the CSV import functionality.
- Functionality: Bulk imports chat data from a CSV file into the WordPress database.
- Description: Exports table data into a CSV format.
- Location: In the CSV export functionality.
- Functionality: Allows downloading of data stored in the table as a CSV file.
Shimanta Das
This README.md
file should be included in the root directory of your GitHub repository to give users a clear understanding of the plugin, its functionality, and how they can connect with you.