salman/igny8
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c47d18c18dff98f5d3c1dcda4095759d0256d69e
igny8/igny8-ai-seo-wp-plugin/docs/COMPLETE_FUNCTION_REFERENCE.md
Desktop f4d62448cf reference plugin and image gen analysis
2025-11-11 21:16:37 +05:00

26 KiB
Raw Blame History

Igny8 AI SEO Plugin - Complete Function Reference

Summary Table

Function Category Function Count Core Functions Dependencies Files Involved
Core System 45+ igny8_init(), igny8_register_settings(), igny8_create_all_tables() WordPress, Database igny8.php, core/admin/init.php, core/db/db.php
AI Integration 25+ igny8_openai_request(), igny8_runware_request(), igny8_generate_content() OpenAI API, Runware API ai/integration.php, ai/openai-api.php, ai/runware-api.php
Database Management 30+ igny8_create_all_tables(), igny8_migrate_data(), igny8_cleanup_legacy_structures() MySQL, WordPress core/db/db.php, core/db/db-migration.php
Workflow Automation 40+ igny8_sync_post_meta_data(), igny8_inject_responsive_images_separate(), igny8_ajax_bulk_publish_drafts() WordPress, Database flows/sync-functions.php, flows/sync-ajax.php, flows/image-injection-responsive.php
Module Management 20+ igny8_is_module_enabled(), igny8_get_enabled_modules(), igny8_register_module() WordPress, Database core/admin/module-manager-class.php, core/admin/init.php
CRON Automation 15+ igny8_master_dispatcher_run(), igny8_process_ai_queue_cron_handler(), igny8_auto_cluster_cron_handler() WordPress CRON, Database core/cron/igny8-cron-master-dispatcher.php, core/cron/igny8-cron-handlers.php
Admin Interface 35+ igny8_render_table(), igny8_render_filters(), igny8_render_pagination() WordPress Admin, JavaScript core/admin/, modules/components/
Analytics & KPI 25+ igny8_get_kpi_data_safe(), igny8_track_metrics(), igny8_generate_reports() Database, WordPress core/admin/global-helpers.php, modules/config/kpi-config.php

1. CORE SYSTEM FUNCTIONS

1.1 Plugin Initialization Functions

igny8_init()

  • Purpose: Main plugin initialization function
  • Dependencies: WordPress hooks, database setup
  • Files: igny8.php
  • Functionality: Plugin setup, hook registration, module initialization
  • Returns: Boolean success status

igny8_register_settings()

  • Purpose: WordPress settings registration
  • Dependencies: WordPress settings API
  • Files: core/admin/init.php
  • Functionality: Settings group and field registration
  • Returns: Boolean registration status

igny8_init_wordpress_features()

  • Purpose: WordPress feature initialization
  • Dependencies: WordPress core, taxonomies, post meta
  • Files: core/admin/init.php
  • Functionality: Taxonomy registration, post meta setup
  • Returns: Boolean initialization status

1.2 Database Management Functions

igny8_create_all_tables()

  • Purpose: Create all custom database tables
  • Dependencies: WordPress database, table schemas
  • Files: core/db/db.php
  • Functionality: Table creation, schema setup
  • Returns: Boolean creation status

igny8_register_taxonomies()

  • Purpose: Register custom taxonomies
  • Dependencies: WordPress taxonomy system
  • Files: core/db/db.php
  • Functionality: Taxonomy registration, term setup
  • Returns: Boolean registration status

igny8_register_post_meta()

  • Purpose: Register post meta fields
  • Dependencies: WordPress post meta system
  • Files: core/db/db.php
  • Functionality: Meta field registration, validation setup
  • Returns: Boolean registration status

igny8_set_default_options()

  • Purpose: Set default plugin options
  • Dependencies: WordPress options API
  • Files: core/db/db.php
  • Functionality: Default option values setup
  • Returns: Boolean setup status

1.3 Migration Functions

igny8_migrate_logs_table()

  • Purpose: Migrate logs table structure
  • Dependencies: Database system, migration scripts
  • Files: core/db/db-migration.php
  • Functionality: Table structure migration
  • Returns: Boolean migration status

igny8_add_word_count_to_tasks()

  • Purpose: Add word count column to tasks table
  • Dependencies: Database system, table structure
  • Files: core/db/db-migration.php
  • Functionality: Column addition, data migration
  • Returns: Boolean addition status

igny8_add_tasks_count_to_content_ideas()

  • Purpose: Add tasks count to content ideas
  • Dependencies: Database system, content ideas table
  • Files: core/db/db-migration.php
  • Functionality: Column addition, count calculation
  • Returns: Boolean addition status

igny8_add_image_prompts_to_content_ideas()

  • Purpose: Add image prompts to content ideas
  • Dependencies: Database system, content ideas table
  • Files: core/db/db-migration.php
  • Functionality: Column addition, prompt setup
  • Returns: Boolean addition status

igny8_update_idea_description_to_longtext()

  • Purpose: Update idea description to longtext
  • Dependencies: Database system, content ideas table
  • Files: core/db/db-migration.php
  • Functionality: Column type update, data preservation
  • Returns: Boolean update status

igny8_cleanup_legacy_structures()

  • Purpose: Clean up legacy database structures
  • Dependencies: Database system, legacy data
  • Files: core/db/db-migration.php
  • Functionality: Legacy cleanup, data migration
  • Returns: Boolean cleanup status

2. AI INTEGRATION FUNCTIONS

2.1 OpenAI API Functions

igny8_openai_request()

  • Purpose: Make OpenAI API requests
  • Dependencies: OpenAI API, authentication
  • Files: ai/openai-api.php
  • Functionality: API communication, response handling
  • Returns: API response data

igny8_generate_content()

  • Purpose: Generate AI content using OpenAI
  • Dependencies: OpenAI API, content data
  • Files: ai/modules-ai.php
  • Functionality: Content generation, prompt processing
  • Returns: Generated content

igny8_ai_cluster_keywords()

  • Purpose: AI-powered keyword clustering
  • Dependencies: OpenAI API, keyword data
  • Files: ai/modules-ai.php
  • Functionality: Semantic clustering, keyword grouping
  • Returns: Clustered keywords

igny8_ai_generate_ideas()

  • Purpose: Generate content ideas using AI
  • Dependencies: OpenAI API, cluster data
  • Files: ai/modules-ai.php
  • Functionality: Idea generation, content planning
  • Returns: Generated content ideas

2.2 Runware API Functions

igny8_runware_request()

  • Purpose: Make Runware API requests
  • Dependencies: Runware API, authentication
  • Files: ai/runware-api.php
  • Functionality: API communication, image generation
  • Returns: API response data

igny8_generate_images_for_post()

  • Purpose: Generate images for WordPress posts
  • Dependencies: Runware API, post data
  • Files: ai/modules-ai.php
  • Functionality: Image generation, post integration
  • Returns: Generated images

igny8_generate_images_for_content_idea()

  • Purpose: Generate images for content ideas
  • Dependencies: Runware API, content idea data
  • Files: ai/modules-ai.php
  • Functionality: Image generation, idea integration
  • Returns: Generated images

2.3 AI Integration Functions

igny8_get_ai_setting()

  • Purpose: Get AI-related settings
  • Dependencies: WordPress options, AI configuration
  • Files: ai/integration.php
  • Functionality: Setting retrieval, configuration access
  • Returns: AI setting value

igny8_set_ai_setting()

  • Purpose: Set AI-related settings
  • Dependencies: WordPress options, AI configuration
  • Files: ai/integration.php
  • Functionality: Setting storage, configuration update
  • Returns: Boolean setting status

igny8_validate_ai_response()

  • Purpose: Validate AI API responses
  • Dependencies: AI APIs, response data
  • Files: ai/integration.php
  • Functionality: Response validation, error handling
  • Returns: Boolean validation status

3. WORKFLOW AUTOMATION FUNCTIONS

3.1 Sync Functions

igny8_sync_post_meta_data()

  • Purpose: Synchronize post metadata
  • Dependencies: WordPress post meta, database
  • Files: flows/sync-functions.php
  • Functionality: Meta synchronization, data consistency
  • Returns: Boolean sync status

igny8_sync_post_meta_ajax()

  • Purpose: AJAX post meta synchronization
  • Dependencies: WordPress AJAX, post meta
  • Files: flows/sync-ajax.php
  • Functionality: AJAX sync, real-time updates
  • Returns: JSON response

igny8_handle_keyword_cluster_update()

  • Purpose: Handle keyword cluster updates
  • Dependencies: Database, cluster data
  • Files: flows/sync-functions.php
  • Functionality: Cluster update processing
  • Returns: Boolean update status

3.2 Image Injection Functions

igny8_inject_responsive_images_separate()

  • Purpose: Inject responsive images into posts
  • Dependencies: WordPress posts, image data
  • Files: flows/image-injection-responsive.php
  • Functionality: Image injection, responsive setup
  • Returns: Boolean injection status

igny8_process_image_injection()

  • Purpose: Process image injection workflow
  • Dependencies: Post data, image data
  • Files: flows/image-injection-responsive.php
  • Functionality: Injection processing, workflow management
  • Returns: Boolean processing status

3.3 AJAX Functions

igny8_ajax_bulk_publish_drafts()

  • Purpose: Bulk publish drafts via AJAX
  • Dependencies: WordPress AJAX, post data
  • Files: core/admin/ajax.php
  • Functionality: Bulk publishing, progress tracking
  • Returns: JSON response

igny8_ajax_sync_post_meta()

  • Purpose: AJAX post meta synchronization
  • Dependencies: WordPress AJAX, post meta
  • Files: flows/sync-ajax.php
  • Functionality: Real-time sync, data updates
  • Returns: JSON response

4. MODULE MANAGEMENT FUNCTIONS

4.1 Module Manager Functions

igny8_is_module_enabled()

  • Purpose: Check if module is enabled
  • Dependencies: Module manager, module data
  • Files: core/admin/module-manager-class.php
  • Functionality: Module status checking
  • Returns: Boolean enabled status

igny8_get_enabled_modules()

  • Purpose: Get all enabled modules
  • Dependencies: Module manager, module data
  • Files: core/admin/module-manager-class.php
  • Functionality: Module listing, status filtering
  • Returns: Array of enabled modules

igny8_register_module()

  • Purpose: Register new module
  • Dependencies: Module manager, module data
  • Files: core/admin/module-manager-class.php
  • Functionality: Module registration, configuration
  • Returns: Boolean registration status

igny8_get_module_config()

  • Purpose: Get module configuration
  • Dependencies: Module manager, module data
  • Files: core/admin/module-manager-class.php
  • Functionality: Configuration retrieval
  • Returns: Module configuration array

4.2 Module Initialization Functions

igny8_init_modules()

  • Purpose: Initialize all modules
  • Dependencies: Module manager, module data
  • Files: core/admin/module-manager-class.php
  • Functionality: Module initialization, setup
  • Returns: Boolean initialization status

igny8_load_module()

  • Purpose: Load specific module
  • Dependencies: Module manager, module files
  • Files: core/admin/module-manager-class.php
  • Functionality: Module loading, file inclusion
  • Returns: Boolean load status

5. CRON AUTOMATION FUNCTIONS

5.1 Master Dispatcher Functions

igny8_master_dispatcher_run()

  • Purpose: Run master CRON dispatcher
  • Dependencies: WordPress CRON, automation data
  • Files: core/cron/igny8-cron-master-dispatcher.php
  • Functionality: CRON orchestration, task management
  • Returns: Boolean execution status

igny8_get_defined_cron_jobs()

  • Purpose: Get all defined CRON jobs
  • Dependencies: CRON configuration, job data
  • Files: core/cron/igny8-cron-master-dispatcher.php
  • Functionality: Job listing, configuration retrieval
  • Returns: Array of CRON jobs

igny8_check_cron_health()

  • Purpose: Check CRON system health
  • Dependencies: CRON system, health data
  • Files: core/cron/igny8-cron-master-dispatcher.php
  • Functionality: Health monitoring, status checking
  • Returns: Health status array

5.2 CRON Handler Functions

igny8_process_ai_queue_cron_handler()

  • Purpose: Process AI queue via CRON
  • Dependencies: AI queue, CRON system
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Queue processing, AI task execution
  • Returns: Boolean processing status

igny8_auto_cluster_cron_handler()

  • Purpose: Auto cluster keywords via CRON
  • Dependencies: Keyword data, clustering system
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Automated clustering, keyword processing
  • Returns: Boolean clustering status

igny8_auto_generate_ideas_cron_handler()

  • Purpose: Auto generate ideas via CRON
  • Dependencies: Cluster data, idea generation
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Automated idea generation
  • Returns: Boolean generation status

igny8_auto_queue_cron_handler()

  • Purpose: Auto queue tasks via CRON
  • Dependencies: Task data, queue system
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Automated task queuing
  • Returns: Boolean queuing status

igny8_auto_generate_content_cron_handler()

  • Purpose: Auto generate content via CRON
  • Dependencies: Content data, generation system
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Automated content generation
  • Returns: Boolean generation status

igny8_auto_publish_drafts_cron_handler()

  • Purpose: Auto publish drafts via CRON
  • Dependencies: Draft data, publishing system
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Automated draft publishing
  • Returns: Boolean publishing status

igny8_auto_optimizer_cron_handler()

  • Purpose: Auto optimize content via CRON
  • Dependencies: Content data, optimization system
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Automated content optimization
  • Returns: Boolean optimization status

igny8_auto_recalc_cron_handler()

  • Purpose: Auto recalculate metrics via CRON
  • Dependencies: Metric data, calculation system
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Automated metric recalculation
  • Returns: Boolean calculation status

igny8_health_check_cron_handler()

  • Purpose: Health check via CRON
  • Dependencies: System data, health monitoring
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: System health monitoring
  • Returns: Boolean health status

igny8_auto_generate_images_cron_handler()

  • Purpose: Auto generate images via CRON
  • Dependencies: Image data, generation system
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Automated image generation
  • Returns: Boolean generation status

5.3 CRON Utility Functions

igny8_safe_create_term()

  • Purpose: Safely create taxonomy terms
  • Dependencies: WordPress taxonomy, term data
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Term creation, error handling
  • Returns: Term ID or false

igny8_safe_create_cluster_term()

  • Purpose: Safely create cluster terms
  • Dependencies: WordPress taxonomy, cluster data
  • Files: core/cron/igny8-cron-handlers.php
  • Functionality: Cluster term creation, error handling
  • Returns: Term ID or false

6. ADMIN INTERFACE FUNCTIONS

6.1 Table Rendering Functions

igny8_render_table()

  • Purpose: Render data tables
  • Dependencies: Table data, configuration
  • Files: modules/components/table-tpl.php
  • Functionality: Table rendering, data display
  • Returns: HTML table output

igny8_render_filters()

  • Purpose: Render table filters
  • Dependencies: Filter data, configuration
  • Files: modules/components/filters-tpl.php
  • Functionality: Filter rendering, user interface
  • Returns: HTML filter output

igny8_render_pagination()

  • Purpose: Render table pagination
  • Dependencies: Pagination data, configuration
  • Files: modules/components/pagination-tpl.php
  • Functionality: Pagination rendering, navigation
  • Returns: HTML pagination output

igny8_render_table_actions()

  • Purpose: Render table actions
  • Dependencies: Action data, configuration
  • Files: modules/components/actions-tpl.php
  • Functionality: Action rendering, user interface
  • Returns: HTML action output

6.2 Form Rendering Functions

igny8_render_forms()

  • Purpose: Render forms
  • Dependencies: Form data, configuration
  • Files: modules/components/forms-tpl.php
  • Functionality: Form rendering, user interface
  • Returns: HTML form output

igny8_render_import_modal()

  • Purpose: Render import modal
  • Dependencies: Import data, configuration
  • Files: modules/components/import-modal-tpl.php
  • Functionality: Import modal rendering
  • Returns: HTML modal output

igny8_render_export_modal()

  • Purpose: Render export modal
  • Dependencies: Export data, configuration
  • Files: modules/components/export-modal-tpl.php
  • Functionality: Export modal rendering
  • Returns: HTML modal output

6.3 KPI Rendering Functions

igny8_render_kpi()

  • Purpose: Render KPI displays
  • Dependencies: KPI data, configuration
  • Files: modules/components/kpi-tpl.php
  • Functionality: KPI rendering, metrics display
  • Returns: HTML KPI output

7. ANALYTICS & KPI FUNCTIONS

7.1 KPI Data Functions

igny8_get_kpi_data_safe()

  • Purpose: Safely get KPI data
  • Dependencies: Database, KPI configuration
  • Files: core/admin/global-helpers.php
  • Functionality: KPI data retrieval, error handling
  • Returns: KPI data array

igny8_calculate_kpi_metrics()

  • Purpose: Calculate KPI metrics
  • Dependencies: Raw data, calculation algorithms
  • Files: core/admin/global-helpers.php
  • Functionality: Metric calculation, data processing
  • Returns: Calculated metrics array

igny8_track_metrics()

  • Purpose: Track performance metrics
  • Dependencies: Performance data, tracking system
  • Files: core/admin/global-helpers.php
  • Functionality: Metric tracking, data storage
  • Returns: Boolean tracking status

7.2 Analytics Functions

igny8_analyze_performance()

  • Purpose: Analyze performance data
  • Dependencies: Performance data, analysis algorithms
  • Files: core/admin/global-helpers.php
  • Functionality: Performance analysis, insights generation
  • Returns: Analysis results array

igny8_generate_reports()

  • Purpose: Generate analytics reports
  • Dependencies: Analytics data, report templates
  • Files: core/admin/global-helpers.php
  • Functionality: Report generation, data visualization
  • Returns: Generated reports

igny8_visualize_data()

  • Purpose: Visualize analytics data
  • Dependencies: Analytics data, visualization tools
  • Files: core/admin/global-helpers.php
  • Functionality: Data visualization, chart generation
  • Returns: Visualized data

8. UTILITY FUNCTIONS

8.1 Helper Functions

igny8_get_cluster_term_name()

  • Purpose: Get cluster term name
  • Dependencies: WordPress taxonomy, term data
  • Files: core/admin/global-helpers.php
  • Functionality: Term name retrieval
  • Returns: Term name string

igny8_get_cluster_options()

  • Purpose: Get cluster options for dropdowns
  • Dependencies: Cluster data, taxonomy
  • Files: core/admin/global-helpers.php
  • Functionality: Options generation, dropdown data
  • Returns: Options array

igny8_get_dynamic_table_config()

  • Purpose: Get dynamic table configuration
  • Dependencies: Table data, configuration
  • Files: core/admin/global-helpers.php
  • Functionality: Configuration generation, table setup
  • Returns: Table configuration array

igny8_get_difficulty_range_name()

  • Purpose: Get difficulty range name
  • Dependencies: Difficulty data, range configuration
  • Files: core/admin/global-helpers.php
  • Functionality: Range name retrieval
  • Returns: Range name string

8.2 Logging Functions

igny8_write_log()

  • Purpose: Write to log system
  • Dependencies: Logging system, log data
  • Files: core/admin/global-helpers.php
  • Functionality: Log writing, error tracking
  • Returns: Boolean log status

igny8_log_error()

  • Purpose: Log errors
  • Dependencies: Error data, logging system
  • Files: core/admin/global-helpers.php
  • Functionality: Error logging, debugging
  • Returns: Boolean log status

igny8_log_debug()

  • Purpose: Log debug information
  • Dependencies: Debug data, logging system
  • Files: core/admin/global-helpers.php
  • Functionality: Debug logging, troubleshooting
  • Returns: Boolean log status

8.3 Validation Functions

igny8_validate_record()

  • Purpose: Validate database records
  • Dependencies: Record data, validation rules
  • Files: core/admin/global-helpers.php
  • Functionality: Record validation, data integrity
  • Returns: Boolean validation status

igny8_validate_foreign_key()

  • Purpose: Validate foreign key relationships
  • Dependencies: Key data, relationship rules
  • Files: core/admin/global-helpers.php
  • Functionality: Foreign key validation
  • Returns: Boolean validation status

igny8_sanitize_data()

  • Purpose: Sanitize input data
  • Dependencies: Input data, sanitization rules
  • Files: core/admin/global-helpers.php
  • Functionality: Data sanitization, security
  • Returns: Sanitized data

9. FRONTEND FUNCTIONS

9.1 JavaScript Functions

igny8_init_table()

  • Purpose: Initialize data tables
  • Dependencies: JavaScript, table data
  • Files: assets/js/core.js
  • Functionality: Table initialization, user interface
  • Returns: Boolean initialization status

igny8_handle_ajax()

  • Purpose: Handle AJAX requests
  • Dependencies: JavaScript, AJAX data
  • Files: assets/js/core.js
  • Functionality: AJAX handling, data processing
  • Returns: AJAX response

igny8_process_image_queue()

  • Purpose: Process image generation queue
  • Dependencies: JavaScript, image data
  • Files: assets/js/image-queue-processor.js
  • Functionality: Queue processing, progress tracking
  • Returns: Boolean processing status

9.2 CSS Functions

igny8_load_styles()

  • Purpose: Load CSS styles
  • Dependencies: CSS files, styling data
  • Files: assets/css/core.css
  • Functionality: Style loading, visual presentation
  • Returns: Boolean load status

igny8_apply_responsive_design()

  • Purpose: Apply responsive design
  • Dependencies: CSS, responsive data
  • Files: assets/css/core.css
  • Functionality: Responsive design application
  • Returns: Boolean application status

10. INTEGRATION FUNCTIONS

10.1 WordPress Integration

igny8_integrate_wordpress()

  • Purpose: Integrate with WordPress core
  • Dependencies: WordPress hooks, core functions
  • Files: igny8.php, core/admin/init.php
  • Functionality: WordPress integration, hook registration
  • Returns: Boolean integration status

igny8_register_hooks()

  • Purpose: Register WordPress hooks
  • Dependencies: WordPress hooks, action/filter system
  • Files: flows/sync-hooks.php
  • Functionality: Hook registration, event handling
  • Returns: Boolean registration status

10.2 API Integration

igny8_integrate_apis()

  • Purpose: Integrate with external APIs
  • Dependencies: API credentials, HTTP client
  • Files: ai/integration.php
  • Functionality: API integration, data exchange
  • Returns: Boolean integration status

igny8_handle_api_errors()

  • Purpose: Handle API errors
  • Dependencies: API responses, error handling
  • Files: ai/integration.php
  • Functionality: Error handling, recovery
  • Returns: Boolean error handling status

Function Dependencies Summary

Core Dependencies

  • WordPress: Hooks, actions, filters, database
  • PHP: Core language functions, extensions
  • MySQL: Database operations, queries
  • JavaScript: Client-side functionality, AJAX

External Dependencies

  • OpenAI API: Content generation, AI processing
  • Runware API: Image generation, visual content
  • cURL: HTTP communication, API requests
  • JSON: Data serialization, API communication

Internal Dependencies

  • Database Layer: Custom tables, queries, migrations
  • Module System: Module management, configuration
  • CRON System: Automation, scheduled tasks
  • Admin Interface: User interface, data management

File Structure Dependencies

  • Core Files: Plugin initialization, system setup
  • Module Files: Feature-specific implementations
  • AI Files: AI service integrations
  • Workflow Files: Process automation, data sync
  • Asset Files: Frontend resources, styling

This comprehensive function reference covers all aspects of the Igny8 AI SEO Plugin's function library, providing detailed information about each function's purpose, dependencies, and implementation details.

Reference in New Issue View Git Blame Copy Permalink