{"id":23024044,"url":"https://github.com/x-wp/updater","last_synced_at":"2025-10-27T06:19:12.136Z","repository":{"id":181606790,"uuid":"667048976","full_name":"x-wp/updater","owner":"x-wp","description":"WP Package Updater -Simplifies the process of updating WordPress packages from custom repositories","archived":false,"fork":false,"pushed_at":"2025-05-24T16:05:06.000Z","size":13469,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-24T13:26:41.952Z","etag":null,"topics":["plugin-update","theme-update","wordpress","wordpress-library","wordpress-repository"],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/oblak/wp-package-updater","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/x-wp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"seebeen"}},"created_at":"2023-07-16T13:25:44.000Z","updated_at":"2025-05-16T13:39:51.000Z","dependencies_parsed_at":"2024-11-15T02:22:30.938Z","dependency_job_id":"d4fc6376-5ef0-4d54-81a3-52fe0dc3c69c","html_url":"https://github.com/x-wp/updater","commit_stats":null,"previous_names":["oblakstudio/wp-package-updater","x-wp/updater"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/x-wp/updater","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-wp%2Fupdater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-wp%2Fupdater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-wp%2Fupdater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-wp%2Fupdater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/x-wp","download_url":"https://codeload.github.com/x-wp/updater/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-wp%2Fupdater/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281225143,"owners_count":26464484,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-27T02:00:05.855Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["plugin-update","theme-update","wordpress","wordpress-library","wordpress-repository"],"created_at":"2024-12-15T13:16:19.019Z","updated_at":"2025-10-27T06:19:12.091Z","avatar_url":"https://github.com/x-wp.png","language":"PHP","funding_links":["https://github.com/sponsors/seebeen"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# 📦 WordPress package updater\n\n### Simplifies the process of updating WordPress packages from custom repositories.\n\n[![Packagist Version](https://img.shields.io/packagist/v/oblak/wp-package-updater)](https://packagist.org/packages/oblak/wp-package-updater)\n![Packagist PHP Version](https://img.shields.io/packagist/dependency-v/oblak/wp-package-updater/php)\n[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)\n\n![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/oblakstudio/wp-package-updater)\n[![Release](https://github.com/oblakstudio/wp-package-updater/actions/workflows/release.yml/badge.svg)](https://github.com/oblakstudio/wp-package-updater/actions/workflows/release.yml)\n\n![GitHub](https://img.shields.io/github/license/oblakstudio/wp-package-updater)\n![Packagist Downloads](https://img.shields.io/packagist/dm/oblak/wp-package-updater)\n\n\u003c/div\u003e\n\n## Highlights\n * Standardizes the process of updating plugins / themes from custom repositories.\n * Fully integrates with Plugin / theme info API.\n * Easily extendable / customizable\n\n## Installation\n\nWe officially support installing via composer only\n\n### Via composer\n```bash\ncomposer require oblak/wp-package-updater\n```\n\n## Basic Usage\n\n```Plugin_Updater``` and ```Theme_Updater``` are the main **abstract** classes of the package, and they need to be extended in order to create an updater class.\nThe class is responsible for registering the plugin / theme update hooks, and for updating the plugin / theme.\n\nAt minimum you need to implement the ``get_update_url()`` method, which is responsible for returning the update info URL.\n\n### 1. Define your updater class\n\n```php\n\u003c?php\nnamespace Vendor\\My_Plugin;\n\nuse Oblak\\WP\\Plugin_Updater;\nuse Oblak\\WP\\Theme_Updater;\n\n\n\nclass My_Plugin_Updater extends Plugin_Updater {\n\n    protected function get_update_url() {\n        return 'https://my-plugin.com/api/update';\n    }\n\n}\n\nclass My_Theme_Updater extends Theme_Updater {\n\n    protected function get_update_url() {\n        return 'https://my-theme.com/api/update';\n    }\n\n}\n```\n\n### 2. Include the autoload file\n```php\nrequire_once __DIR__ . 'vendor/autoload.php';\n```\n\n### 3. Instantiate the updater class\n```php\n\u003c?php\n\nuse Vendor\\My_Plugin\\My_Plugin_Updater;\nuse Vendor\\My_Plugin\\My_Theme_Updater;\n\nnew My_Plugin_Updater('plugin-slug');\nnew My_Theme_Updater('theme-slug');\n```\n\n## Advanced Usage\n\nDepending on your needs, you can override several methods in the updater class to customize the update process according to your repository API.\n\nSome of the functions you can customize:\n\n* ``get_headers`` - Returns the headers for the update request.\n* ``send_request`` - Sends the update request to the repository API.\n* ``validate_response`` - Validates the response from the repository API.\n* ``get_transient_prefix`` - Returns the transient prefix for the plugin / theme update information.\n\n## Contributing\n\nContributions are welcome from everyone. We have [contributing guidelines](CONTRIBUTING.md) to help you get started.\n\n## Credits and special thanks\n\nThis project is maintained by [Oblak Studio](https://oblak.studio).\n\n## License\n\nThis project is licensed under the [GNU General Public License v2.0](LICENSE).\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fx-wp%2Fupdater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fx-wp%2Fupdater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fx-wp%2Fupdater/lists"}