{"id":23379419,"url":"https://github.com/log-oscon/bnp-disclaimer","last_synced_at":"2025-04-08T06:37:48.329Z","repository":{"id":146347370,"uuid":"74469393","full_name":"log-oscon/bnp-disclaimer","owner":"log-oscon","description":"Result of the training sessions at BNP Paribas","archived":false,"fork":false,"pushed_at":"2016-11-22T12:17:06.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-14T04:19:23.922Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/log-oscon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2016-11-22T12:15:15.000Z","updated_at":"2016-11-22T12:17:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"c5a6c5d3-e4a8-416b-9b39-53c552047b50","html_url":"https://github.com/log-oscon/bnp-disclaimer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/log-oscon%2Fbnp-disclaimer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/log-oscon%2Fbnp-disclaimer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/log-oscon%2Fbnp-disclaimer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/log-oscon%2Fbnp-disclaimer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/log-oscon","download_url":"https://codeload.github.com/log-oscon/bnp-disclaimer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247792900,"owners_count":20996892,"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-21T19:18:35.368Z","updated_at":"2025-04-08T06:37:48.282Z","avatar_url":"https://github.com/log-oscon.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WordPress Plugin Boilerplate\n\nA standardized, organized, object-oriented foundation for building high-quality WordPress Plugins\n\nThis is a fork of the original WordPress Plugin Boilerplate project, with added namespace and autoloader support.\n\n## Features\n\n* The Boilerplate is based on the [Plugin API](http://codex.wordpress.org/Plugin_API), [Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards), and [Documentation Standards](http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/).\n* All classes, functions, and variables are documented so that you know what you need to be changed.\n* The Boilerplate uses a strict file organization scheme that correspond both to the WordPress Plugin Repository structure, and that make it easy to organize the files that compose the plugin.\n* The project includes a `.pot` file as a starting point for internationalization.\n\n## Installation\n\nThe Boilerplate can be installed in one of two ways both of which are documented below.\n\n### Copying a Directory\n\n1. Clone the directory into your `wp-content/plugins` directory.\n2. Change into the cloned directory and execute `composer install`.\n3. In the WordPress dashboard, navigate to the *Plugins* page and locate the menu item that reads “The WordPress Plugin Boilerplate.”\n4. Click on *Activate.*\n\n### Creating a Symbolic Link\n\n#### On Linux or OS X\n\n1. Copy the `WordPress-Plugin-Boilerplate` directory into your `wp-content/plugins` directory.\n2. Create a symbolic link between the `trunk` directory and the plugin. For example: `ln -s plugin-name/trunk /path/to/wordpress/wp-content/plugins/plugin-name`\n3. In the WordPress dashboard, navigation to the *Plugins* page\nLocate the menu item that reads “The WordPress Plugin Boilerplate.”\n4. Click on *Activate.*\n\n#### On Windows\n\n1. Copy the `WordPress-Plugin-Boilerplate` directory into your `wp-content/plugins` directory.\n2. Create a symbolic link between the `trunk` directory and the plugin. For example: `mklink /J path\\to\\wp-content\\plugins \\path\\to\\WordPress-Plugin-Boilerplate\\trunk\\plugin-name`\n3. In the WordPress dashboard, navigation to the *Plugins* page\nLocate the menu item that reads “The WordPress Plugin Boilerplate.”\n4. Click on *Activate.*\n\nNote that this will activate the source code of the Boilerplate, but because the Boilerplate has no real functionality so no menu  items, meta boxes, or custom post types will be added.\n\nExamples are slated to be added to the [Boilerplate’s website](http://wppb.io) as the site continues to grow.\n\n## Recommended Tools\n\n### i18n Tools\n\nThe WordPress Plugin Boilerplate uses a variable to store the text domain used when internationalizing strings throughout the Boilerplate. To take advantage of this method, there are tools that are recommended for providing correct, translatable files:\n\n* [Poedit](http://www.poedit.net/)\n* [makepot](http://i18n.svn.wordpress.org/tools/trunk/)\n* [i18n](https://github.com/grappler/i18n)\n\nAny of the above tools should provide you with the proper tooling to internationalize the plugin.\n\n## License\n\nThe WordPress Plugin Boilerplate is licensed under the GPL v2 or later.\n\n\u003e This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.\n\n\u003e This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n\n\u003e You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nA copy of the license is included in the root of the plugin’s directory. The file is named `LICENSE`.\n\n## Important Notes\n\n### Licensing\n\nThe WordPress Plugin Boilerplate is licensed under the GPL v2 or later; however, if you opt to use third-party code that is not compatible with v2, then you may need to switch to using code that is GPL v3 compatible.\n\nFor reference, [here's a discussion](http://make.wordpress.org/themes/2013/03/04/licensing-note-apache-and-gpl/) that covers the Apache 2.0 License used by [Bootstrap](http://twitter.github.io/bootstrap/).\n\n### Includes\n\nNote that if you include your own classes, or third-party libraries, there are three locations in which said files may go:\n\n* `lib/Common` is where functionality shared between the dashboard and the public-facing parts of the side reside.\n* `lib/Admin` is for all dashboard-specific functionality.\n* `lib/Frontend` is for all public-facing functionality.\n\nThe example code provided shows how to register your hooks with the `Loader` class. More information will be provided in the upcoming documentation on the website.\n\n### Assets\n\nThe `assets` directory contains three files.\n\n1. `banner-772x250.png` is used to represent the plugin’s header image.\n2. `icon-256x256.png` is a used to represent the plugin’s icon image (which is new as of WordPress 4.0).\n3. `screenshot-1.png` is used to represent a single screenshot of the plugin that corresponds to the “Screenshots” heading in your plugin `README.txt`.\n\nThe WordPress Plugin Repository directory structure contains three directories:\n\n1. `assets`\n2. `branches`\n3. `trunk`\n\nThe Boilerplate offers support for `assets` and `trunk` as `branches` is something that isn’t often used and, when it is, is done so under advanced circumstances.\n\nWhen committing code to the WordPress Plugin Repository, all of the banner, icon, and screenshot should be placed in the `assets` directory of the Repository, and the core code should be placed in the `trunk` directory.\n\n### What About Other Features?\n\nThe previous version of the WordPress Plugin Boilerplate included support for a number of different projects such as the [GitHub Updater](https://github.com/afragen/github-updater).\n\nThese tools are not part of the core of this Boilerplate, as I see them as being additions, forks, or other contributions to the Boilerplate.\n\nThe same is true of using tools like Grunt, Composer, etc. These are all fantastic tools, but not everyone uses them. In order to  keep the core Boilerplate as light as possible, this feature have been removed and will be introduced in other editions, and will be listed and maintained on the project homepage\n\n# Credits\n\nThe WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and has since included a number of great contributions.\n\nThe current version of the Boilerplate was developed in conjunction with [Josh Eaton](https://twitter.com/jjeaton), [Ulrich Pogson](https://twitter.com/grapplerulrich), and [Brad Vincent](https://twitter.com/themergency).\n\nThe homepage is based on a design as provided by [HTML5Up](http://html5up.net), the Boilerplate logo was designed by  Rob McCaskill of [BungaWeb](http://bungaweb.com), and the site `favicon` was created by [Mickey Kay](https://twitter.com/McGuive7).\n\n## Documentation, FAQs, and More\n\nBecause this version is a major rewrite of the core plugin, we’re working to create an entire site around the Boilerplate. If you’re interested, please [let me know](http://tommcfarlin.com/contact) and we’ll see what we can do.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flog-oscon%2Fbnp-disclaimer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flog-oscon%2Fbnp-disclaimer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flog-oscon%2Fbnp-disclaimer/lists"}