Can i use PSRs in wordpress vs the WordPress Coding Standards?
I am going to create a plugin but I want to use psrs and take advantage of all its features.
psr4
libs
Absolutely, and it is best to use it for plugin development.
But as you know it is not recommended by the wordpress community one reason is it can be problematic if other plugins or the theme share identical packages installed via composer
But to use PSR4 or somthing similar just start your project with a composer.json and structure it with the correct file path for development for your plugin. Look at the example snippet below declaring autoload in composer.json followed by the PSR and the path
EXAMPLE: composer.json
{
"name": "author/myplugin",
"type": "wordpress-plugin",
"description": "Description",
"require": {
"php": ">=7.4"
},
"autoload": {
"psr-4": {
"MYPLUGIN\\": "src/Includes/"
}
}
}
Related
I am setting up a WordPress site with BedRock and was thinking if there is a way to "require" the ACF plugin in my composer.
So the plan is to have clean and simple repo where you do a git pull and composer install and then everything gets installed (including plugins)
But I don't find any documentation on the ACF site on how to do this.
Is this even possible? lol
I found this package but it's for ACF Pro and I just need the free version.
https://github.com/PhilippBaschke/acf-pro-installer
If anyone has any experience with BedRock and can help me out that would be greatly appreciated :)
Many thanks in advance!
If you add the wpackagist repository to Composer's "repositories", you can then require the ACF free version.
In Bedrock's composer.json add the wp-packagist repo:
"repositories": [
{
"type": "composer",
"url": "https://wpackagist.org"
}
],
...
Then in the same file, require the plugin:
"require": {
"php": ">=5.6",
"composer/installers": "~1.0.12",
"vlucas/phpdotenv": "^2.0.1",
"johnpbloch/wordpress": "4.7.2",
"oscarotero/env": "^1.0",
"roots/wp-password-bcrypt": "1.0.0",
"roots/soil": "3.7.1",
"wpackagist-plugin/advanced-custom-fields" : "4.1.*"
},
...
Run composer update and it should fetch the plugin.
Side note, the https://github.com/PhilippBaschke/acf-pro-installer tool is no longer supported and doesn't work with Composer 2 or ACF versions > 5.10.x
To fix the second issue with ACF versions, in src/ACFProInstaller/Plugin.php edit line 187 to:
$major_minor_patch_optional = '/\A\d\.\d{1,2}\.\d{1,2}(?:\.\d)?\Z/';
For Composer 2 compatibility, see
https://github.com/pivvenit/acf-pro-installer and https://github.com/ffraenz/private-composer-installer are two options for replacements.
https://github.com/PhilippBaschke/acf-pro-installer/issues/44 describes the differences concisely.
I'm using Roots/Bedrock for my WordPress structure and I want to use WebDevStudios/CMB2 as a library and not as a plugin.
The Roots/Bedrock composer.json specifies that dependencies of type:wordpress-plugin be installed in app/plugins. The WebDevStudios/CMB2 composer.json declares that it is a wordpress-plugin type, so it gets installed into app/plugins which is not where I want it.
How can I get this dependency to be installed into vendor and not app/plugins?
I have a suspicion I might have to fork CMB2 and change it's type from wordpress-plugin to library, but I'm hoping there is a cleaner solution.
I'm not using Roots/Bedrock but I had a similar problem when adding CMB2 as a dependency to a plugin (rather than loading it as a separate plugin). It was installing the plugin in wp-content/plugins instead of vendor. The following worked for me.
{
"require": {
"webdevstudios/cmb2": "^2.2",
},
"autoload" : {
"files": [
"vendor/webdevstudios/cmb2/init.php"
]
},
"extra": {
"installer-paths": {
"vendor/webdevstudios/cmb2": ["webdevstudios/cmb2"]
}
}
}
The key was the installer-paths entry that tells Composer where we want to install webdevstudios/cmb2.
I wrote a blog post about this at https://salferrarello.com/cmb2-composer-dependency/
My current project will be cms-like, and I contemplate about a plugin system.
My problem: Like many other cms', I wanna have a plugins/ directory in the root, just to simplify it for the user. A custom script in the AppKernel will then load all the plugins/bundles form this directory. But I don't have even the slightest clue how to load bundles from other directorys. Does somebody here have experience in this situation?
King regards, hice3000.
It seems like your problem is solved. But to answer your question, as that can help other people.
Loading bundles is just making sure the bundle class can be autoloaded. By default, Composer can load classes from the packages it installs. The Symfony Standard Edition configures the Composer autoloader to also load classes from src using this code in composer.json:
{
...
"autoload": {
"psr-0": { "": "src/" }
}
}
You can extend this to also load classes from the plugin directory:
{
...
"autoload": {
"psr-0": { "": "src/", "": "plugin/" }
}
}
Read more in their docs
Ideal Situation
Often while working on a Symfony2 project I will spot something I want to change in one of my dependencies. If I could find a way to simply change it in vendor and then easily push the changes as a pull request then I would probably contribute more often (rather than overriding the part with a local child bundle).
The Problem
I can't change a vendor directory without composer freaking out on the next update. If I submit a pull request then it may take quite some time before I can actually use the code in vendors, which is actually a deterrent from contributing my new functionality.
How I do it now
The way I typically contribute to a bundle is to make a fork, put the fork in a barebones symfony standard-edition app, make the change and then submit a pull request.
Put fork in composer.json?
The only solution I can think of, is removing the packagist dependency of the bundle I am editing, and then including my fork with composer (as a package) from github. That way I get my code immediately and can still contribute.
Is this the only solution? How do you do it?
Any tips/advice for contributing to a bundle while working on a different project at the same time would be appreciated!
Nah... this is broken.
I've tried the official way to include a fork, here's an example (original:kitano, fork: jstoeffler) of the composer.json :
(For those who are in a hurry: THIS DOESNT WORK)
"repositories": [
//...
{
"type": "vcs",
"url": "https://github.com/jstoeffler/KitanoConnectionBundle",
},
//...
],
It keeps using the original bundle. Don't know what the problem is, and I don't get how everything works, but here's how I successfully add a fork to a project.
"repositories": [
//...
{
"type": "package",
"package": {
"name": "kitano/connection-bundle",
"version": "dev-master",
"source": {
"url": "https://github.com/jstoeffler/KitanoConnectionBundle.git",
"type": "git",
"reference": "master"
},
"autoload": {
"classmap": [""]
}
}
},
//...
],
[UPDATE: Answer Not Valid Anymore]
As pointed out in one of the comments, this answer is a couple years old and not correct anymore. See answers below for the correct way to proceed.
[Original answer below]
This is the approach recommended by Jordi Boggiano (#Seldaek), creator of composer.
See from his talk at Symfony Live San Francisco earlier this year (at the 2 minutes mark):
http://www.youtube.com/watch?list=PLo7mBDsRHu11ChvScWUE7MN1Qo5QVHQEz&feature=player_detailpage&v=P3NwF8RV1lY#t=120s
As of 2017 the proper way to do it is:
Add your GitHub branch link to the repositories
"repositories": [
{
"type": "vcs",
"url": "https://github.com/crimson-med/yii2-link-preview"
}
],
Add the source to the require of your composer.json
"require": {
"yii2mod/yii2-link-preview": "dev-master"
},
FYI, I just tried the very first option:
"repositories": [{
"type": "vcs",
"url": "https://github.com/thujohn/twitter"
}],
"require": {
"laravel/framework": "4.2.*",
"thujohn/twitter": "dev-master",
"anahkiasen/flickering": "^0.1.2",
"fairholm/elasticquent": "dev-master",
"facebook/php-sdk-v4" : "~5.0"
},
An it worked fine.
vagrant#dev:/var/www$ sudo php composer.phar update
Loading composer repositories with package information Updating dependencies (including require-dev)
- Removing thujohn/twitter (2.0.4)
- Installing thujohn/twitter (dev-master 7a92118)
Downloading: 100%
Writing lock file
Generating autoload files
> php artisan clear-compiled
> php artisan optimize
Generating optimized class loader
I just needed to specify the "master" branch name as "dev-master".
With Symfony 2.0.x I store all my client side dependencies (jQuery, etc) in the deps file so I can easily update them all at once with vendor/install, with the switch to composer in 2.1 this is not possible. My options appear to be:
Fork all repos and add in the composer.json file (pain in the butt and waste of time)
Manually download them all and stick them inside my repo somewhere (also a pain in the butt)
Write my own Grunt script or something similar
Does anyone have a solution for handling this, or am I going about it all wrong?
Composer does have support for downloading libraries that are not Composer-aware. It's a little more work, but you can define each of your dependencies like this:
{
"repositories": [
{
"type": "package",
"package": {
"name": "jquery/jquery",
"version": "1.8.1",
"dist": {
"url": "http://code.jquery.com/jquery-1.8.1.min.js",
"type": "file"
}
}
}
],
"require": {
"jquery/jquery": "1.8.1"
}
}
Read more about it here: http://getcomposer.org/doc/05-repositories.md#package-2.
This will download jQuery to vendors/jquery/jquery by default. I don't think there's a way to specify a directory outside of vendors at the moment, so that may considerably limit the usefulness of this suggestion.
FWIW, I would consider submitting a pull request/issue to the Composer Github project. This actually would make a whole lot of sense.