{"id":21701029,"url":"https://github.com/ed-itsolutions/wup-client","last_synced_at":"2026-05-13T05:43:42.424Z","repository":{"id":56974827,"uuid":"137735369","full_name":"Ed-ITSolutions/wup-client","owner":"Ed-ITSolutions","description":"The client for WUP","archived":false,"fork":false,"pushed_at":"2019-09-11T08:03:07.000Z","size":20,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-25T15:09:36.220Z","etag":null,"topics":["wordpress-php-library","wordpress-updater"],"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/Ed-ITSolutions.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":"2018-06-18T09:53:39.000Z","updated_at":"2023-05-03T18:53:01.000Z","dependencies_parsed_at":"2022-08-21T11:50:28.785Z","dependency_job_id":null,"html_url":"https://github.com/Ed-ITSolutions/wup-client","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ed-ITSolutions%2Fwup-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ed-ITSolutions%2Fwup-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ed-ITSolutions%2Fwup-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ed-ITSolutions%2Fwup-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ed-ITSolutions","download_url":"https://codeload.github.com/Ed-ITSolutions/wup-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244645245,"owners_count":20486950,"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","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-php-library","wordpress-updater"],"created_at":"2024-11-25T20:17:40.321Z","updated_at":"2026-05-13T05:43:42.367Z","avatar_url":"https://github.com/Ed-ITSolutions.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WUP Client\n\nClient side code for [WP Update Provider](https://github.com/Ed-ITSolutions/wp-update-provider).\n\n## Install\n\nUsing Composer:\n\n```\ncomposer require ed-itsolutions/wup-client\n```\n\n## Usage\n\nRequire composer as normal.\n\nAdd `wup_client` to your `functions.php` or plugin class.\n\n```php\n// For a plugin\nwup_client('plugin', 'plugin-slug', 'http://your.site.com/wup/plugin-slug');\n\n// For a theme\nwup_client('theme', 'theme-slug', 'http://your.site.com/wup/theme-slug');\n//                                 ^^ URL of your WUP install.\n```\n\nThat's it!\n\nwup-client will now talk to WUP and offer updates when needed.\n\n## CI\n\nwup-client also provides the `wup_build` function which can be used to have your CI build and release a new version of your plugin automatically.\n\n```php\nwup_build(\n  'theme-slug', // The themes (or plugins) slug.\n  '/some/path', // The root path of the theme/plugin. Use dirname(__FILE__) to make this generic.\n  'deployKey', // The deploy key for the server. DON'T ACTUALLY PUT THIS IN VCS. ProTip. getenv('WUP_DEPLOY_KEY')\n  'http://yoursite.com/wp-admin/admin-post.php' // The admin-post.php url for your site.\n);\n```\n\nExit Codes:\n\n - 1 - Something went wrong deploying to domain.\n - 2 - No deploy key set.\n\n ## Client Conflict Resolution\n\n WUP-Client may end up in multiple plugins on the same site. It maybe that it is being used by 2 wp-update-provider servers and you have no control over updating the other installations.\n\n To prevent issues where pluginA uses wup-client 0.0.X and pluginB uses 0.1.X may cause pluginB to use 0.0.X's `WUPClient` class a system is in place to ensure that the lastest version of WUPClient is used by all plugins and themes on the site.\n\n If breaking changes are introduced a system will be devised to ensure that WUPClient is used within the correct major version.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fed-itsolutions%2Fwup-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fed-itsolutions%2Fwup-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fed-itsolutions%2Fwup-client/lists"}