Initial commit of slide manager plugin
This commit is contained in:
@@ -0,0 +1,110 @@
|
||||
# Hi-School Slide Manager
|
||||
|
||||
A WordPress plugin to manage slides for Hi-School websites.
|
||||
|
||||
## Features
|
||||
|
||||
- Custom post type for slides management
|
||||
- Easy-to-use admin interface
|
||||
- Shortcode support for displaying slides
|
||||
- Responsive design
|
||||
- Image upload support
|
||||
- Customizable slide display
|
||||
|
||||
## Installation
|
||||
|
||||
1. Upload the plugin files to the `/wp-content/plugins/hi-school-slide-manager/` directory
|
||||
2. Activate the plugin through the 'Plugins' screen in WordPress
|
||||
3. Use the 'Slides' menu in the WordPress admin to manage your slides
|
||||
|
||||
## Usage
|
||||
|
||||
### Admin Interface
|
||||
|
||||
1. Navigate to "Slides" in your WordPress admin menu
|
||||
2. Create new slides with titles, content, and images
|
||||
3. Manage existing slides through the standard WordPress interface
|
||||
|
||||
### Shortcode
|
||||
|
||||
Display slides on any page or post using the shortcode:
|
||||
|
||||
```
|
||||
[hssm_slides]
|
||||
```
|
||||
|
||||
Shortcode parameters:
|
||||
- `count` - Number of slides to display (default: 5)
|
||||
- `category` - Filter slides by category (optional)
|
||||
|
||||
Examples:
|
||||
```
|
||||
[hssm_slides count="3"]
|
||||
[hssm_slides count="10" category="featured"]
|
||||
```
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
hi-school-slide-manager/
|
||||
├── hi-school-slide-manager.php # Main plugin file
|
||||
├── includes/
|
||||
│ ├── HSSM_Autoloader.php # Autoloader class
|
||||
│ └── HSSM_Plugin.php # Main plugin class
|
||||
├── assets/
|
||||
│ ├── css/
|
||||
│ │ ├── frontend.css # Frontend styles
|
||||
│ │ └── admin.css # Admin styles
|
||||
│ └── js/
|
||||
│ ├── frontend.js # Frontend JavaScript
|
||||
│ └── admin.js # Admin JavaScript
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Hooks and Filters
|
||||
|
||||
### Actions
|
||||
- `hssm_before_slide_display` - Fired before displaying a slide
|
||||
- `hssm_after_slide_display` - Fired after displaying a slide
|
||||
|
||||
### Filters
|
||||
- `hssm_slide_content` - Filter slide content before display
|
||||
- `hssm_shortcode_atts` - Filter shortcode attributes
|
||||
|
||||
## Customization
|
||||
|
||||
### CSS Classes
|
||||
|
||||
The plugin uses the following CSS classes for styling:
|
||||
- `.hssm-slides-container` - Main container for slides
|
||||
- `.hssm-slide` - Individual slide wrapper
|
||||
- `.hssm-slide-content` - Slide content area
|
||||
- `.hssm-slide-image` - Slide image container
|
||||
|
||||
### Custom Templates
|
||||
|
||||
You can override the slide display by creating custom templates in your theme:
|
||||
- `single-hssm_slide.php` - Single slide template
|
||||
- `archive-hssm_slide.php` - Slide archive template
|
||||
|
||||
## Requirements
|
||||
|
||||
- WordPress 5.0 or higher
|
||||
- PHP 7.4 or higher
|
||||
|
||||
## License
|
||||
|
||||
This plugin is licensed under the GPL v2 or later.
|
||||
|
||||
## Support
|
||||
|
||||
For support and questions, please contact the plugin developer.
|
||||
|
||||
## Changelog
|
||||
|
||||
### 1.0.0
|
||||
- Initial release
|
||||
- Basic slide management functionality
|
||||
- Shortcode support
|
||||
- Admin interface
|
||||
- Responsive design
|
||||
Reference in New Issue
Block a user