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.
Problem/Motivation
The current state of the Block system API documentation is pretty bad:
The main change record at https://drupal.org/node/1880620 is quite out of date and does not reflect two major rewrites of the API.- Not any more, I rewrote the thing from ground up. chx, 2014 February 24.- There are numerous very stale issues missing their change records or change record updates:
#1927608: Remove the tight coupling between Block Plugins and Block Entitiesfolded into the BAP change notice. chx, 2014 February 24.#2014215: Shift render array defaults back out onto BlockRenderControllerfolded into the BAP change notice. chx, 2014 February 24.
- There are several plugin API changes that might also impact the BAP change record:
- The Block API handbook page is just a stub: https://drupal.org/node/2168137
- There are numerous documentation-related followups and @todo, some of which have been outstanding since the original BAP conversion:
Proposed resolution
Resolve the above issues. Provide handbook, codebase, and change record documentation that will be useful to developers upgrading modules to D8 or creating new D8 modules. Preferably before beta. (I'm tempted to consider this beta-blocking--the change records are independently anyway--but calling it a beta target for now.)
Remaining tasks
- Write comprehensive handbook and codebase API documentation.
- Update the relevant change records to show minimal D7 to D8 examples and reference the handbook documentation.
- Resolve the issues linked above.
Comments
Comment #1
xjmComment #2
xjmComment #3
chx CreditAttribution: chx commentedI can't help with code any more but I think I can help with documentation. I will write on the way home which is Monday in practically every time zone (it's a very long Monday for me).
Comment #4
chx CreditAttribution: chx commentedI didn't assign to me because if someone gets to this before Monday , go for it.
Comment #5
chx CreditAttribution: chx commentedComment #6
chx CreditAttribution: chx commentedComment #7
xjmThis issue was marked as a beta target for the 8.0.x beta, but is not applicable as an 8.1.x beta target, so untagging.
Since most of the child issues were resolved, I'm also going to mark this as duplicate.