Developer Reference
Constants
| Constant | Defined Location | Description |
|---|---|---|
SITEDOCS_VERSION | Main plugin file | Plugin version |
SITEDOCS_PLUGIN_FILE | Main plugin file | Absolute plugin file path |
SITEDOCS_PLUGIN_DIR | Main plugin file | Plugin directory path |
SITEDOCS_PLUGIN_URL | Main plugin file | Plugin URL |
Autoloader
SiteDocs uses a PSR-4-style custom autoloader. Class name conventions:
| Class Prefix | Directory |
|---|---|
SiteDocs_Core | includes/class-sitedocs-core.php |
SiteDocs_Scanner | includes/class-sitedocs-scanner.php |
SiteDocs_Admin | admin/class-sitedocs-admin.php |
Filters
| Filter | Arguments | Description |
|---|---|---|
sitedocs_scan_data | $data (array) | Modify scan data before sending to AI |
sitedocs_sections | $sections (array) | Modify section list before generation |
sitedocs_ai_prompt | $prompt (string), $section (string) | Modify AI prompt per section |
sitedocs_pdf_footer | $text (string) | Override PDF footer text |
sitedocs_role_visibility | $roles (array) | Override roles allowed to view docs |
Actions
| Action | Arguments | Description |
|---|---|---|
sitedocs_scan_complete | $data (array) | Fires after site scan completes |
sitedocs_generated | $sections (array) | Fires after full documentation generation |
sitedocs_section_generated | $section (string), $content (string) | Fires after each section is generated |
sitedocs_changelog_entry | $entry (array) | Fires when a changelog entry is created |
AJAX Handlers
| Action | Handler | Description |
|---|---|---|
sitedocs_generate | SiteDocs_Core::ajax_generate() | Trigger documentation generation |
sitedocs_clear | SiteDocs_Core::ajax_clear() | Clear all documentation |
sitedocs_mark_read | SiteDocs_Core::ajax_mark_read() | Mark section as read |
sitedocs_reset_read_status | SiteDocs_Core::ajax_reset_read_status() | Clear read markers for current user |
sitedocs_save_video_link | SiteDocs_Core::ajax_save_video_link() | Save a video attachment |
sitedocs_delete_video_link | SiteDocs_Core::ajax_delete_video_link() | Remove a video attachment |
sitedocs_ai_chat | SiteDocs_Core::ajax_ai_chat() | Handle AI chat query |
sitedocs_translate_section | SiteDocs_Core::ajax_translate_section() | Translate a section |
Default Settings
| Key | Default | Description |
|---|---|---|
ai_provider | '' | AI provider name |
auto_generate | false | Auto-generation toggle |
agency_name | '' | Branding name |
agency_logo | '' | Logo URL |
agency_color | #000000 | Brand colour |
role_visibility | ['administrator'] | Allowed roles |
pdf_footer_text | '' | PDF footer |
woocommerce_module | false | WooCommerce documentation |
multisite_support | false | Multisite mode |
support_url | '' | Support link URL |
support_label | Contact Support | Support link text |
translation_language | '' | Target translation language |
show_dashboard_widget | true | Dashboard widget visibility |
screenshot_api_key | '' | Screenshot API key |