{"id":23387236,"url":"https://github.com/wp-forge/wp-plugin","last_synced_at":"2025-04-08T12:34:09.466Z","repository":{"id":205228835,"uuid":"713672031","full_name":"wp-forge/wp-plugin","owner":"wp-forge","description":"A WordPress plugin template that can be easily installed using Composer.","archived":false,"fork":false,"pushed_at":"2023-11-03T19:33:27.000Z","size":1136,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T08:37:37.862Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/wp-forge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-03T02:08:39.000Z","updated_at":"2024-04-08T10:52:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"174ffc97-80b2-4d83-8633-1372d720692a","html_url":"https://github.com/wp-forge/wp-plugin","commit_stats":null,"previous_names":["wp-forge/wp-plugin"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-forge%2Fwp-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-forge%2Fwp-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-forge%2Fwp-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-forge%2Fwp-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wp-forge","download_url":"https://codeload.github.com/wp-forge/wp-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247843597,"owners_count":21005475,"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":[],"created_at":"2024-12-22T01:15:21.398Z","updated_at":"2025-04-08T12:34:09.453Z","avatar_url":"https://github.com/wp-forge.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WordPress Plugin\n\nA WordPress plugin scaffolding template that can be easily installed using Composer.\n\n## Requirements\n\n- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)\n- [Composer](https://getcomposer.org/doc/00-intro.md)\n- [Node](https://nodejs.org/)\n- [Docker](https://www.docker.com/) (optional)\n\n## Installation\n\nRun this command in the terminal:\n\n```\ncomposer --remove-vcs create-project wp-forge/wp-plugin\n``` \n\n**Be sure to append a directory name to the end of the command to customize the folder name that your project will be\ninstalled into!**\n\nThe installation process will check your environment for the required PHP version and PHP extensions. If this presents a\nproblem and you want to force install anyway, just add the `--ignore-platform-reqs` flag to the command.\n\n## Notes\n\n- The `.scripts` and `.templates` folders are used for scaffolding purposes only and won't exist in your end project.\n- We use the `@wordpress/env` package to provide a local development environment. This package requires Docker to be\n  installed on your machine. If you don't want to use Docker, you can remove the `@wordpress/env` package from the\n  `package.json` file and delete the `.wp-env.json` file.\n- We use the concept of a hooks folder. Rather than having a bunch of WordPress hooks scattered around your\n  plugin, the `hooks` folder contains an `actions` and `filters` folder where each file name corresponds to the name of\n  a hook (except with dashes in place of underscores). All items that belong in a particular hook are added to the\n  appropriate file, making it easy to find, edit, and add hooks in a consistent way.\n- This repo has a `source` folder, where you can store any files that require a build step (e.g. scss and js). The\n  `assets` folder is where you store the compiled files that will be used in your plugin. By default, we .gitignore\n  the `assets/css` and `assets/js` folders.\n- Currently, this template does not implement any kind of build process. This is something that will be added in the\n  future.\n- This repo creates an `.nvmrc` file. If you use [NVM](https://github.com/nvm-sh/nvm), you'll be able to run `nvm use`\n  to automatically switch to the correct version of Node for this project. It will default to the version of Node that\n  is running on your machine at the time of install.\n- This template creates GitHub Action workflows for your plugin. If you are publicly releasing your plugin on the\n  WordPress.org plugin directory, you will need to add a `SVN_USERNAME` and `SVN_PASSWORD` environment variable to your\n  GitHub repository settings.\n- If your plugin is to be publicly released, the `.wporg` folder is used to store the assets that will be uploaded to\n  the WordPress.org plugin repository.\n\n## Reminders\n\nDon't forget to:\n\n- Run `git remote add origin \u003curl\u003e` to add your remote repository\n- Add a `SVN_USERNAME` and `SVN_PASSWORD` environment variable to your GitHub repository settings (if your plugin is to\n  be publicly released)\n- Push your code to GitHub by running `git push -u origin master`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwp-forge%2Fwp-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwp-forge%2Fwp-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwp-forge%2Fwp-plugin/lists"}