Changeset 50516

Timestamp:

03/09/2021 10:33:47 PM (6 years ago)

Author:

peterwilsoncc

Message:

Docs: Improve compatibility comment in WP_List_Table.

Improve comment explaining backward compatibility check for the primary column in WP_List_Table::get_column_info().

Unprops helen, markjaquith.
See #52628, #34564.

File:

• trunk/src/wp-admin/includes/class-wp-list-table.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-list-table.php

@@ -1112 +1112 @@
                 // $_column_headers is already set / cached.
                 if ( isset( $this->_column_headers ) && is_array( $this->_column_headers ) ) {
-                        // Back-compat for list tables that have been manually setting $_column_headers for horse reasons.
-                        // In 4.3, we added a fourth argument for primary column.
+                        /*
+                         * Backward compatibility for `$_column_headers` format prior to WordPress 4.3.
+                         *
+                         * In WordPress 4.3 the primary column name was added as a forth item in the
+                         * column headers property. This ensures the primary column name is included
+                         * in plugins setting the property directly in the three item format.
+                         */
                         $column_headers = array( array(), array(), array(), $this->get_primary_column_name() );
                         foreach ( $this->_column_headers as $key => $value ) {