{"id":17660542,"url":"https://github.com/cba85/wp-icarus-framework","last_synced_at":"2026-04-28T22:31:30.436Z","repository":{"id":62500259,"uuid":"210202374","full_name":"cba85/wp-icarus-framework","owner":"cba85","description":"Modern framework that helps you quickly write simple yet powerful Wordpress plugin","archived":false,"fork":false,"pushed_at":"2021-04-26T15:42:25.000Z","size":89,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-15T01:49:07.396Z","etag":null,"topics":["wordpress","wordpress-development","wordpress-php-library","wordpress-plugin"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cba85.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-22T19:26:06.000Z","updated_at":"2023-02-16T07:20:06.000Z","dependencies_parsed_at":"2022-11-02T12:01:31.095Z","dependency_job_id":null,"html_url":"https://github.com/cba85/wp-icarus-framework","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/cba85/wp-icarus-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cba85%2Fwp-icarus-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cba85%2Fwp-icarus-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cba85%2Fwp-icarus-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cba85%2Fwp-icarus-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cba85","download_url":"https://codeload.github.com/cba85/wp-icarus-framework/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cba85%2Fwp-icarus-framework/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32402666,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T19:38:08.556Z","status":"ssl_error","status_checked_at":"2026-04-28T19:37:55.688Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["wordpress","wordpress-development","wordpress-php-library","wordpress-plugin"],"created_at":"2024-10-23T17:07:34.837Z","updated_at":"2026-04-28T22:31:30.418Z","avatar_url":"https://github.com/cba85.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WP Icarus framework\n\nWordpress Icarus plugin framework.\n\n## Install\n\nVia Composer\n\n```\n$ composer require cba85/wp-icarus-framework\n```\n\n## Usage\n\n### Bootstrap\n\n```php\nuse Icarus\\Plugin;\n\nrequire __DIR__ . '/../vendor/autoload.php';\n\nnew Plugin();\n```\n\n### Facades\n\nYou can use components as objects:\n\n```php\nuse Icarus\\Assets\\Script;\n\n$script = new Script(__DIR__ . '/js');\n$script-\u003eadd('style1-name', 'style.css', [], false, 'all')\n    -\u003eadd('style2-name', 'style2.css', [], false, 'all')\n    -\u003esave();\n```\n\nYou can also use some components as facades:\n\n```php\n Hook::register('activation', __FILE__, function () {\n        return new HookController;\n    });\n```\n\n## Components\n\n### Config\n\n```php\nuse Icarus\\Config\\Config;\n\n$config = new Config;\n\n// Bind a configuration file\n$config-\u003ebind(['test' =\u003e require __DIR__ . '/config/test.php']);\n\n// Get a key from a configuration file\n$config-\u003eget('test')['key']; // Value\n```\n\nConfig file example:\n\n```php\nreturn [\n    'name' =\u003e 'WP Icarus plugin',\n    'view' =\u003e __DIR__ . '/../resources/views/',\n    'styles' =\u003e  __DIR__ . '/../public/css/',\n    'scripts' =\u003e __DIR__ . '/../public/js/',\n];\n```\n\n### View\n\nYour view files name must end with `.view.php` (e.g. `filename.view.php`);\n\n```php\nuse Icarus\\View\\View;\n\n$view = new View;\n$view-\u003esetPath(__DIR__ . '/views/');\n\n$view-\u003erender('filename');\n$view-\u003erender('filename', ['key' =\u003e 'value']); // With data\n```\n\n### Style\n\n```php\nuse Icarus\\Assets\\Style;\n\n(new Style)-\u003esetPath(Config::get('plugin')['styles'])\n    -\u003eadd('style1-name', 'style.css', [], false, 'all')\n    -\u003eadd('style2-name', 'style2.css', [], false, 'all')\n    -\u003esave('wp_enqueue_style');\n```\n\n### Script\n\n```php\nuse Icarus\\Assets\\Script;\n\n(new Script)-\u003esetPath(Config::get('plugin')['scripts'])\n        -\u003eadd('scripts', 'scripts.js', [], false, true)\n        -\u003eadd('admin', 'admin.js', [], false, true)\n        -\u003esave('wp_enqueue_script');\n```\n\n### Menu\n\n#### Facade\n\n```php\nMenu::create(function () {\n\n    Menu::addPage('page', 'menu', 'capability', 'slug', function () {\n        return (new \\Icarus\\Tests\\Mocks\\AdminController)-\u003eindex();\n    });\n\n    Menu::addSubPage('parent', 'page', 'menu', 'capability', 'slug', function () {\n        return (new \\Icarus\\Tests\\Mocks\\AdminController)-\u003eindex();\n    });\n\n});\n```\n\n### Session\n\n#### Facade\n\n```php\nSession::set('success', \"Success test\");\necho Session::has('success'); // True\necho Session::get('success'); // Success test\nSession::remove('success');\nSession::all();\nSession::flush();\n```\n\n### Notice\n\n#### Facade\n\n```php\n// Create a notice message\nNotice::setKey(\"icarus-framework\")-\u003ecreate('success', \"Success test\");\n\n// Display a notice message\nNotice::display();\n```\n\n### Hook\n\n#### Facade\n\n```php\nHook::register('activation', __FILE__, function () {\n    new ActivationHook;\n})-\u003eregister('deactivation', __FILE__, function () {\n    new DeactivationHook;\n});\n```\n\n### Admin\n\n#### Facade\n\n```php\nAdmin::action('process_test', function () {\n    return $this-\u003esave();\n});\n```\n\n## Models\n\n### Table\n\n```php\n\u003c?php\n\nnamespace Icarus\\Plugin\\Models;\n\nuse Icarus\\Models\\Tables\\Table;\n\nclass Post extends Table\n{\n    public function table()\n    {\n        global $wpdb;\n\n        return $wpdb-\u003eprefix . 'posts';\n    }\n\n    public function key()\n    {\n        return 'ID';\n    }\n\n    public function fields()\n    {\n        return [];\n    }\n}\n```\n\n### Option\n\n```php\n\u003c?php\n\nnamespace Icarus\\Plugin\\Models;\n\nuse Icarus\\Models\\Tables\\Option;\n\nclass WoocommerceOption extends Option\n{\n    public function prefix()\n    {\n        return 'woocommerce_';\n    }\n\n    public function fields()\n    {\n        return [\n            'status',\n        ];\n    }\n}\n```\n\n### Meta\n\n```php\n\u003c?php\n\nnamespace Icarus\\Plugin\\Models;\n\nuse Icarus\\Models\\Tables\\Meta;\n\nclass ShippingMeta extends Meta\n{\n    public function prefix()\n    {\n        return '_shipping_';\n    }\n\n    public function fields()\n    {\n        return [\n            'first_name',\n            'last_name',\n            'company',\n            'address_1',\n            'address_2',\n            'city',\n            'postcode',\n            'country',\n        ];\n    }\n}\n```\n\n## Testing\n\n```\n$ ./vendor/bin/phpunit\n```\n\nOr\n\n```\n$ composer run-script test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcba85%2Fwp-icarus-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcba85%2Fwp-icarus-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcba85%2Fwp-icarus-framework/lists"}