The Love-Hate Relationship Between Composer and WordPress (WordCamp Netherlands 2015)

Transcript

1. 1.

   The Love-Hate Relationship Between Composer and WordPress @CoenJacobs at #wcnl

   2015
2. 2.

   Hello My name is Coen Jacobs Developer at Radish Concepts

   Jumped out of the bubble Still do WordPress projects
3. 3.

   Outside of the WordPress ecosystem, fun stuff happens too!

4. 4.

   Composer “Composer is a tool for dependency management in PHP.

   It allows you to declare the libraries your project depends on and it will manage (install/ update) them for you.”
5. 5.

   What does Composer do? » Load your dependencies » Loads

   dependencies of your dependencies » And so on... » Offers a powerful autoloader » Inspired by npm and bundler » Made by Jordi Boggiano
6. 6.

   Alright, but how does it work?

7. 7.

   Autoloading

8. 8.

   Manual loading... require_once 'classes/class-core.php'; require_once 'includes/wpseo-local-functions.php'; require_once 'includes/ajax-functions.php'; require_once 'classes/class-core.php';

   require_once 'classes/class-admin.php'; require_once 'classes/class-admin-wrappers.php'; require_once 'classes/class-metaboxes.php'; require_once 'classes/class-frontend.php'; require_once 'classes/class-storelocator.php'; require_once 'classes/class-taxonomy.php';
9. 9.

   Classmap: "autoload": { "classmap": [ "includes" ] } PSR-4: "autoload":

   { "psr-4": {"Never5\\ WPNotificationCenter\\": "src/"} }
10. 10.

    Just add require 'vendor/autoload.php'; That's it Does this for dependencies

    as well
11. 11.

    Even PHP 5.2 compatible

12. 12.

    All plugins should use Composer autoloading, seriously! (if you have

    more than one file)
13. 13.

    Nothing but love so far!

14. 14.

    Trust me, we'll get to the good stuff soon!

15. 15.

    Dependency management

16. 16.

    Say, you have a fancy library or want to use

    one
17. 17.

    Add it to your composer.json "require": { "wpupdatephp/wp-update-php": "~1.0" }

    run composer install
18. 18.

    Package will be installed vendor/wpupdatephp/ wp-update-php/ Added to autoloader as

    well
19. 19.

    And one day... (actually, two days ago...)

20. 20.

    Dependency hell

21. 21.

    You'll have this problem with any dependency manager That includes:

    doing it manually
22. 22.

    What's wrong?

23. 23.

    Plugin A: "require": { "wpupdatephp/wp-update-php": "~1.0" } Plugin B: "require":

    { "wpupdatephp/wp-update-php": "~1.0" } Solution: Install WPupdatePHP version 1.0.0, right?
24. 24.

    Sadly, no... Users download zip files, with vendor directory bundled

25. 25.

    Bundling is the only way

26. 26.

    One plugin bundles 1.1.0, the other 1.0.0 Which one is

    used?
27. 27.

    The race is on!

28. 28.

    Include the file or the autoloader autoloader does class_exists check

    first one wins
29. 29.

    In the example, 1.0.0 was loaded the plugin bundling 1.1.0,

    assumes that version is there Fatal error: Call to undefined method
30. 30.

    Now the fun stuff begins!

31. 31.

    What can we do to prevent this?

32. 32.

    Prefix everything!

33. 33.

    Example: Pimple Pimple: namespace Pimple; Danny's prefixed version: namespace ScrollTriggeredBoxes\DI;

34. 34.

    It works But where is the developer happiness?

35. 35.

    Every update of Pimple... Update all the files Someone make

    a SaaS for this...
36. 36.

    How would a developer solve this?

37. 37.

    Manage the entire site via Composer Including WordPress core Everything

    works fine, at least 99% of the time
38. 38.

    What if you can't? Want to bundle something with your

    plugin What if you can't add your site to Composer?
39. 39.

    well...

40. 40.

    Add Composer to your site

41. 41.

    Creates a master composer.json » loop through wp-content/plugins/ » check

    for composer.json file » run wikimedia/composer-merge-plugin » composer install » installed in wp-content/vendor/ At least in theory, this works
42. 42.

    In WordPress core? Maybe Requires PHP 5.3+ Fairly resource intensive

    The only proper solution
43. 43.

    Until that day...

44. 44.

    Thank you! @CoenJacobs coenjacobs.me Want to work with me? We're

    looking for both frontend & backend developers! Contact me or @radishconcepts
45. 45.

    Image credit » Slide 1: https://www.flickr.com/photos/ lizadaly/4373330774/ » Slide 7:

    https://www.flickr.com/photos/ diaper/7328032558/ » Slide 13: https://www.flickr.com/ photos/93277085@N08/12715023064/ » Slide 15: https://www.flickr.com/ photos/dandeluca/2720139047/ » Slide 22: https://www.flickr.com/ photos/usnavy/7879793204/
46. 46.

    Image credit » Slide 27: https://www.flickr.com/ photos/mdpettitt/4954174041/ » Slide 30:

    https://www.flickr.com/ photos/orphanjones/1769903155/ » Slide 36: https://www.flickr.com/ photos/twitteroffice/4524716820/ » Slide 43: https://www.flickr.com/ photos/doug88888/4537134655/