Set default value = [] for sandbox argument of update hooks

Initial patch

Return value is supposed to be ?string but some places using void

Ran the same command from the snippet

git grep _post_update_ |grep sandbox
Applied patch
Ran again
Verified all matches were updated with array

Should we also do regular update hooks whilst we're here?

grep -ir _update_ core |grep sandbox|grep -E "[0-9+]"|grep NULL
core/modules/system/system.install:function system_update_10100(&$sandbox = NULL) {
core/modules/system/system.install:function system_update_10101(&$sandbox = NULL) {
core/modules/forum/forum.install:function forum_update_10100(&$sandbox = NULL) {
core/modules/help/help.install:function help_update_10200(&$sandbox = NULL) {
core/modules/block_content/block_content.install:function block_content_update_10100(&$sandbox = NULL): TranslatableMarkup {
core/modules/locale/locale.install:function locale_update_10100(&$sandbox = NULL) {
core/modules/history/history.install:function history_update_10100(&$sandbox = NULL) {
core/modules/statistics/statistics.install:function statistics_update_10100(&$sandbox = NULL) {
core/modules/dblog/dblog.install:function dblog_update_10100(&$sandbox = NULL) {
core/modules/dblog/dblog.install:function dblog_update_10101(&$sandbox = NULL) {
core/modules/tracker/tracker.install:function tracker_update_10100(&$sandbox = NULL) {
core/modules/comment/comment.install:function comment_update_10100(&$sandbox = NULL) {
core/modules/migrate/migrate.install:function migrate_update_10100(&$sandbox = NULL) {

Sadly it's not possible to use union types with none https://3v4l.org/LQPcN

So I set return type to ?TranslatableMarkup

+++ b/core/lib/Drupal/Core/Extension/module.api.php
@@ -781,7 +781,7 @@ function hook_update_N(&$sandbox) {
+function hook_post_update_NAME(array &$sandbox = []): ?string {

Not sure about ?string as it actually should be Stringable

Moreover in ✨ Add Block Content revision UI Fixed result was defined as TranslatableMarkup

Moreover in #1984588: Add Block Content revision UI result was defined as TranslatableMarkup

TranslatableMarkup implements Stringable.

Additional changes LGTM.

+++ b/core/lib/Drupal/Core/Extension/module.api.php
@@ -765,7 +766,7 @@ function hook_update_N(&$sandbox) {
  *   Stores information for batch updates. See above for more information.
  *
- * @return string|null
+ * @return \Drupal\Core\StringTranslation\TranslatableMarkup|null
  *   Optionally, hook_post_update_NAME() hooks may return a translated string
  *   that will be displayed to the user after the update has completed. If no

I think this should be string|Stringable|null for bc reasons - not that we're enforcing it but it looks like we might.

@catch it's not for BC, it's for new code - the module.api.php is where developers copy/paste so this change will prevent misuse in future and improves API docs

Moving back to committer queue.

We currently specify a string, and if we ever moved update hooks to an interface or similar, we'd probably allow both string and stringable, so I think it should reflect that all three options are allowed.

Let's use it

This is one of those instances I do wish the tests ran. I'm 99% sure they are fine but can you fix the CC failure.

Sorry, fixed patch

Thanks!

I am doing triage on the core RTBC queue → .

The IS sums up the problem and the solution. All questions have been answered. I don't see that there is anything left to do here. Leaving at RTBC.

I did not review the patch nor adjust credit.

The last submitted patch, 14: 3370322-14.patch, failed testing. View results →

requeued

+++ b/core/modules/views/views.post_update.php
@@ -45,14 +45,14 @@ function views_removed_post_updates() {
+function views_post_update_oembed_eager_load(?array &$sandbox = []): void {

@@ -63,7 +63,7 @@ function views_post_update_oembed_eager_load(?array &$sandbox = NULL): void {
+function views_post_update_responsive_image_lazy_load(?array &$sandbox = []): void {

@@ -74,7 +74,7 @@ function views_post_update_responsive_image_lazy_load(?array &$sandbox = NULL):
+function views_post_update_timestamp_formatter(array &$sandbox = []): void {

@@ -85,7 +85,7 @@ function views_post_update_timestamp_formatter(array &$sandbox = NULL): void {
+function views_post_update_fix_revision_id_part(array &$sandbox = []): void {

Is there a reason some of these are nullable while others aren't?

Rerolling #14 for 10.1.x. in case someone else needs it too.