Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.# Summary
Drupal Examples for Developers (AKA 'Examples') is an important source of documentation in the form of executable Drupal API code.
You can use Examples to learn how various APIs work, as well as for template code for your own projects.
Examples currently covers Drupal 6 and 7, with many examples already available for Drupal 8.
# Project URL
https://www.drupal.org/project/examples
# Where is the code?
Find the code on the project page: https://www.drupal.org/project/examples
Note that there are no versioned releases for Examples, only a dev version.
# Estimated completion date
The conversion of and addition to the Drupal 8 version of Examples is an ongoing community project.
# Dependencies
None. Examples only deals with Drupal core APIs.
# Who's doing the port?
The port is a community effort.
# What help do they need?
Any sort of review or new feature is appreciated. If you are learning a new API that doesn't currently have an example, consider writing one and submitting it as your learning exercise. :-)
# D8 roadmap
#1880976: [meta] Port examples (including submodules) to D9.4+
# Background and reference information
N/A.
Comments
Comment #2
Mile23Due to the way this project uses the issue status, this issue should always be set RTBC.
Examples does not have a versioned release (and never has), but is thoroughly tested and has been tracking Drupal 8 since before beta.
Comment #3
Kazanir CreditAttribution: Kazanir commentedI think I'll go ahead and be opinionated on the priority for this one. The linked meta issue makes clear that there's still plenty to do and this module is of immense importance.
Comment #4
Mile23Thanks for the vote of confidence. :-)
Comment #5
webchickVersioned releases would be super useful going forward, I think, since 8.0.0 and 8.1.0 are likely to have different best practices regarding API usage as we introduce new/better things, and deprecate old APIs.
Is that something you're open to at all?
Comment #6
Mile23I'm open to having different branches per Drupal version (8.0.x, 8.1.x). I've been contemplating how that would work, because some issues would require backport while others wouldn't, and I'd rather not have to deal with that if I didn't have to.
But having versioned releases of Examples (like 8.0.x-1.0) doesn't make a lot of sense because there's no good criteria for when such a release is ready. Also, I'd rather people understand that it's an ongoing collection of stuff, and that you shouldn't consider it stable enough for use in production.
Comment #7
BramDriesenOnly a dev version is published.
Comment #8
mmjvb CreditAttribution: mmjvb as a volunteer commentedReverted because of https://www.drupal.org/project/contrib_tracker/issues/2578721#comment-10...
When you feel strong about it, you should provide arguments and try to reach consensus. Personally also disagree with it, but don't feel strong about it. To me, this issue should be about a finite amount of work of porting what was available to D8. And set to Fixed when that work is done.
Comment #9
Mile23A few things:
1) Per #2 and #6, Examples should never have a stable release. Don't use it. :-) Read it and copy it and review your code, but don't use the Examples code itself in production.
2) Examples is currently looking for a new project owner. Get in touch if you're interested.
Comment #10
BramDriesenOkay missed that one, but should it be placed in the contrib tracker then?
Comment #11
Mile23Just a heads-up that the Examples project does not have a maintainer and won't be updated for Drupal 9, unless someone takes over.
Comment #12
valthebaldExamples module now has D9-compatible 3.x branch
Comment #13
apadernoI am giving credits to the users who participated in this issue.