From bfa2a1bfb84d20c417d43aff38c5c40d5d3eaf47 Mon Sep 17 00:00:00 2001 From: Lee Rowlands <lee.rowlands@previousnext.com.au> Date: Wed, 29 Mar 2023 16:41:46 +1000 Subject: [PATCH] Issue #2758915 by mdupont, darvanen, -enzo-, Amber Himes Matz, smustgrave: AJAX commands documentation is misleading when working with render arrays --- core/lib/Drupal/Core/Ajax/AfterCommand.php | 4 ++-- core/lib/Drupal/Core/Ajax/AppendCommand.php | 4 ++-- core/lib/Drupal/Core/Ajax/BeforeCommand.php | 4 ++-- core/lib/Drupal/Core/Ajax/HtmlCommand.php | 2 +- core/lib/Drupal/Core/Ajax/InsertCommand.php | 6 +++--- core/lib/Drupal/Core/Ajax/PrependCommand.php | 4 ++-- core/lib/Drupal/Core/Ajax/ReplaceCommand.php | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/core/lib/Drupal/Core/Ajax/AfterCommand.php b/core/lib/Drupal/Core/Ajax/AfterCommand.php index 41e232d20ebe..0b981177bd61 100644 --- a/core/lib/Drupal/Core/Ajax/AfterCommand.php +++ b/core/lib/Drupal/Core/Ajax/AfterCommand.php @@ -6,8 +6,8 @@ * An AJAX command for calling the jQuery after() method. * * The 'insert/after' command instructs the client to use jQuery's after() - * method to insert the given HTML content after each element matched by the - * given selector. + * method to insert the given render array or HTML content after each element + * matched by the given selector. * * This command is implemented by Drupal.AjaxCommands.prototype.insert() * defined in misc/ajax.js. diff --git a/core/lib/Drupal/Core/Ajax/AppendCommand.php b/core/lib/Drupal/Core/Ajax/AppendCommand.php index 34c751d7ee6f..ae1c2ea80a17 100644 --- a/core/lib/Drupal/Core/Ajax/AppendCommand.php +++ b/core/lib/Drupal/Core/Ajax/AppendCommand.php @@ -6,8 +6,8 @@ * An AJAX command for calling the jQuery append() method. * * The 'insert/append' command instructs the client to use jQuery's append() - * method to append the given HTML content to the inside of each element matched - * by the given selector. + * method to append the given render array or HTML content to the inside of each + * element matched by the given selector. * * This command is implemented by Drupal.AjaxCommands.prototype.insert() * defined in misc/ajax.js. diff --git a/core/lib/Drupal/Core/Ajax/BeforeCommand.php b/core/lib/Drupal/Core/Ajax/BeforeCommand.php index 8de47c8e64eb..f78abb31d35b 100644 --- a/core/lib/Drupal/Core/Ajax/BeforeCommand.php +++ b/core/lib/Drupal/Core/Ajax/BeforeCommand.php @@ -6,8 +6,8 @@ * An AJAX command for calling the jQuery before() method. * * The 'insert/before' command instructs the client to use jQuery's before() - * method to insert the given HTML content before each of elements matched by - * the given selector. + * method to insert the given render array or HTML content before each of + * elements matched by the given selector. * * This command is implemented by Drupal.AjaxCommands.prototype.insert() * defined in misc/ajax.js. diff --git a/core/lib/Drupal/Core/Ajax/HtmlCommand.php b/core/lib/Drupal/Core/Ajax/HtmlCommand.php index e39f08f59f73..ce19c77e1e68 100644 --- a/core/lib/Drupal/Core/Ajax/HtmlCommand.php +++ b/core/lib/Drupal/Core/Ajax/HtmlCommand.php @@ -7,7 +7,7 @@ * * The 'insert/html' command instructs the client to use jQuery's html() method * to set the HTML content of each element matched by the given selector while - * leaving the outer tags intact. + * leaving the outer tags intact using a given render array or HTML markup. * * This command is implemented by Drupal.AjaxCommands.prototype.insert() * defined in misc/ajax.js. diff --git a/core/lib/Drupal/Core/Ajax/InsertCommand.php b/core/lib/Drupal/Core/Ajax/InsertCommand.php index 1813e500645b..65479c3fb4dc 100644 --- a/core/lib/Drupal/Core/Ajax/InsertCommand.php +++ b/core/lib/Drupal/Core/Ajax/InsertCommand.php @@ -5,9 +5,9 @@ /** * Generic AJAX command for inserting content. * - * This command instructs the client to insert the given HTML using whichever - * jQuery DOM manipulation method has been specified in the #ajax['method'] - * variable of the element that triggered the request. + * This command instructs the client to insert the given render array or HTML + * using whichever jQuery DOM manipulation method has been specified in the + * #ajax['method'] variable of the element that triggered the request. * * This command is implemented by Drupal.AjaxCommands.prototype.insert() * defined in misc/ajax.js. diff --git a/core/lib/Drupal/Core/Ajax/PrependCommand.php b/core/lib/Drupal/Core/Ajax/PrependCommand.php index e3902b8f44f7..7cca085a2c0b 100644 --- a/core/lib/Drupal/Core/Ajax/PrependCommand.php +++ b/core/lib/Drupal/Core/Ajax/PrependCommand.php @@ -6,8 +6,8 @@ * AJAX command for calling the jQuery insert() method. * * The 'insert/prepend' command instructs the client to use jQuery's prepend() - * method to prepend the given HTML content to the inside each element matched - * by the given selector. + * method to prepend the given render array or HTML content to the inside each + * element matched by the given selector. * * This command is implemented by Drupal.AjaxCommands.prototype.insert() * defined in misc/ajax.js. diff --git a/core/lib/Drupal/Core/Ajax/ReplaceCommand.php b/core/lib/Drupal/Core/Ajax/ReplaceCommand.php index 25927b7993ba..9d7dcf26688b 100644 --- a/core/lib/Drupal/Core/Ajax/ReplaceCommand.php +++ b/core/lib/Drupal/Core/Ajax/ReplaceCommand.php @@ -7,7 +7,7 @@ * * The 'insert/replaceWith' command instructs the client to use jQuery's * replaceWith() method to replace each element matched by the given selector - * with the given HTML. + * with the given render array or HTML. * * This command is implemented by Drupal.AjaxCommands.prototype.insert() * defined in misc/ajax.js. -- GitLab