Documentation
SiteDocs
Developer Reference

Developer Reference


Constants

ConstantDefined LocationDescription
SITEDOCS_VERSIONMain plugin filePlugin version
SITEDOCS_PLUGIN_FILEMain plugin fileAbsolute plugin file path
SITEDOCS_PLUGIN_DIRMain plugin filePlugin directory path
SITEDOCS_PLUGIN_URLMain plugin filePlugin URL

Autoloader

SiteDocs uses a PSR-4-style custom autoloader. Class name conventions:

Class PrefixDirectory
SiteDocs_Coreincludes/class-sitedocs-core.php
SiteDocs_Scannerincludes/class-sitedocs-scanner.php
SiteDocs_Adminadmin/class-sitedocs-admin.php

Filters

FilterArgumentsDescription
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

ActionArgumentsDescription
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

ActionHandlerDescription
sitedocs_generateSiteDocs_Core::ajax_generate()Trigger documentation generation
sitedocs_clearSiteDocs_Core::ajax_clear()Clear all documentation
sitedocs_mark_readSiteDocs_Core::ajax_mark_read()Mark section as read
sitedocs_reset_read_statusSiteDocs_Core::ajax_reset_read_status()Clear read markers for current user
sitedocs_save_video_linkSiteDocs_Core::ajax_save_video_link()Save a video attachment
sitedocs_delete_video_linkSiteDocs_Core::ajax_delete_video_link()Remove a video attachment
sitedocs_ai_chatSiteDocs_Core::ajax_ai_chat()Handle AI chat query
sitedocs_translate_sectionSiteDocs_Core::ajax_translate_section()Translate a section

Default Settings

KeyDefaultDescription
ai_provider''AI provider name
auto_generatefalseAuto-generation toggle
agency_name''Branding name
agency_logo''Logo URL
agency_color#000000Brand colour
role_visibility['administrator']Allowed roles
pdf_footer_text''PDF footer
woocommerce_modulefalseWooCommerce documentation
multisite_supportfalseMultisite mode
support_url''Support link URL
support_labelContact SupportSupport link text
translation_language''Target translation language
show_dashboard_widgettrueDashboard widget visibility
screenshot_api_key''Screenshot API key