Zeths WP Help

A flexible documentation and help system for WordPress with advanced visibility controls.

Features

• Custom Documentation Post Type - Hierarchical documentation with parent/child pages
• Advanced Visibility Controls - Control who can view each documentation page:
  • Everyone (including guests)
  • All logged-in users
  • Specific user roles
  • Specific individual users
• Customizable Menu Name - Change the admin menu name from the settings page
• Frontend Templates - Clean, responsive documentation display with sidebar navigation
• Breadcrumbs - Easy navigation showing document hierarchy
• Child Pages Display - Automatically shows related topics on parent pages
• Permission Filtering - Automatically hides inaccessible documentation from users

Installation

1. Upload the zeths-wp-help folder to /wp-content/plugins/
2. Activate the plugin through the 'Plugins' menu in WordPress
3. You'll see a new menu item (default: "Help and guides") in your WordPress admin

Usage

Creating Documentation

1. Go to the documentation menu (default: "Help and guides") in WordPress admin
2. Click "Add New"
3. Create your documentation content using the standard WordPress editor
4. Set visibility controls in the "Visibility Settings" sidebar meta box
5. For child pages, select a parent page using the "Page Attributes" panel

Customizing the Menu Name

1. Go to Documentation > Settings
2. Change the "Menu Name" field to your preferred name
3. Save settings and refresh the page to see the change

Visibility Settings

Each documentation page has four visibility modes:

• Everyone (including guests) - Public access, no login required
• All logged-in users - Any user who is logged in can view
• Specific user roles - Select which roles can view (Administrator, Editor, etc.)
• Specific users - Select individual users by name

Frontend Display

• Archive page: Visit /help/ to see all accessible documentation organized by parent/child
• Single page: Click any documentation to view with sidebar navigation and breadcrumbs
• Responsive: Mobile-friendly layout that adapts to screen size

File Structure

zeths-wp-help/
├── zeths-wp-help.php          # Main plugin file
├── includes/
│   ├── post-types/
│   │   └── documentation.php   # Custom post type registration
│   ├── admin/
│   │   ├── meta-boxes.php      # Visibility controls
│   │   ├── settings.php        # Settings page
│   │   └── assets.php          # Admin CSS/JS
│   ├── frontend/
│   │   ├── template-loader.php # Template routing
│   │   └── assets.php          # Frontend CSS
│   └── permissions.php         # Visibility logic
├── templates/
│   ├── single-documentation.php   # Single doc template
│   └── archive-documentation.php  # Archive template
└── assets/
    └── css/
        ├── frontend.css        # Frontend styles
        └── admin.css          # Admin styles

Customization

Theme Templates

You can override plugin templates by copying them to your theme:

your-theme/
└── zeths-wp-help/
    ├── single-documentation.php
    └── archive-documentation.php

Hooks & Filters

The plugin uses standard WordPress hooks. You can customize behavior using:

• pre_get_posts - Modify documentation queries
• the_content - Filter documentation content
• template_include - Override template loading

Requirements

• WordPress 5.0 or higher
• PHP 7.2 or higher

License

GPL v2 or later

Author

Zeth Odderskov

Version

1.0.0