Problem/Motivation

API page: https://api.drupal.org/api/drupal/core!includes!common.inc/function/drup...

Examples in documentation:
drupal_attach_tabledrag('my-module-table', array( ... )

Should be:
drupal_attach_tabledrag($table, array( ... )
and options should include 'table_id' key

Steps to reproduce

Proposed resolution

Give examples of how to set up the form array. And we should definitely not have a call to drupal_render() in there!!

Remaining tasks

Patch
review
commit

User interface changes

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#6 attach-tabledrag-doc-2542780-6.patch910 bytesPravin Ajaaz
#2 attach-tabledrag-doc-2542780-2.patch906 bytesPravin Ajaaz
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Issue tags: -tabledrag, -out of date +Novice

Thanks for reporting this!

We don't actually want random tags on issues -- please read the tag guidelines (link below the tag field).

Anyway, seems like a good thing to fix.

Pravin Ajaaz’s picture

Pravin Ajaaz CreditAttribution: Pravin Ajaaz commented
FileSize
attach-tabledrag-doc-2542780-2.patch906 bytes

Here is a patch which fixes it.

Pravin Ajaaz’s picture

Pravin Ajaaz CreditAttribution: Pravin Ajaaz commented
Status: Active » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community

Hm. OK, that seems like a good change to make. We should have a follow-up issue to fix the documentation up further though. There are all kinds of problems in it, like:
- It doesn't tell you that it can be called automatically if you set up your render array right.
- It shows a call to drupal_render() that we would never actually want to do.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Chapter Three commented
Status: Reviewed & tested by the community » Needs work 
+++ b/core/includes/common.inc
@@ -833,7 +833,8 @@ function drupal_process_states(&$elements) {
+ * drupal_attach_tabledrag($table, array(

@@ -854,7 +855,8 @@ function drupal_process_states(&$elements) {
+ *   drupal_attach_tabledrag($table, array(

It's not $table it's $element.

Pravin Ajaaz’s picture

Pravin Ajaaz CreditAttribution: Pravin Ajaaz commented
FileSize
attach-tabledrag-doc-2542780-6.patch910 bytes

@alexpott: Yes it is. Thanks for pointing.

Pravin Ajaaz’s picture

Pravin Ajaaz CreditAttribution: Pravin Ajaaz commented
Status: Needs work » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Title: drupal_attach_tabledrag() examples in documentation out of date » drupal_attach_tabledrag() examples are a mess
Status: Needs review » Needs work
Issue tags: -Novice

Hm, I don't think that is quite right either.

Really, all of the code on
https://api.drupal.org/api/drupal/core!includes!common.inc/function/drup...
is a mess.

And you wouldn't really call drupal_attach_tabledrag() directly anyway.

So I think this whole doc block should be rewritten and we can't just fix it by this two-line patch. It needs a complete rewrite. I don't think we should give examples of how to call this function, we should just give examples of how to set up the form array. And we should definitely not have a call to drupal_render() in there!!

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone CreditAttribution: quietone at PreviousNext commented
Issue summary: View changes
Issue tags: +Bug Smash Initiative

I used gitblame to determine that the documenation has not been changed. I am not sure what 'mess' means here so I am not sure if this is really a bug or not. There hasn't been any activity here for 7 years which suggests that the documentation is not hindering usage of tabledrag so I am moving this to a task.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.