Commit Graph

135 Commits

Author SHA1 Message Date
Scott Taylor 5547115dc2 Fix some `@param` docs that have chars too close them.
Add `@property` annotations to `WP_User` and `WP_Post`.
Remove erroneous `@param`s from image editor class methods.
Officially add the property `$_column_headers` to `WP_List_Table`.	

See #30799.

Built from https://develop.svn.wordpress.org/trunk@31127


git-svn-id: http://core.svn.wordpress.org/trunk@31108 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-10 06:57:22 +00:00
Scott Taylor bc1341628f Comment List Tables:
* Declare `$extra_items` property
* Since `->get_column_info()` overrides its parent's method, it doesn't need to set `_column_headers`, which is an undeclared property that is only used for caching the lookup after the first run in the parent class, which isn't called in the child class.
* `$_args` in `WP_List_Table` has to be `protected` for `WP_Post_Comments_List_Table` to legally access it. `$_args` is awkward as is and should probably be only available via a getter.

See #30799.

Built from https://develop.svn.wordpress.org/trunk@30984


git-svn-id: http://core.svn.wordpress.org/trunk@30970 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-20 23:27:25 +00:00
Scott Taylor 65ab522a51 Improve various `@param` docs for List Tables.
See #30224.

Built from https://develop.svn.wordpress.org/trunk@30679


git-svn-id: http://core.svn.wordpress.org/trunk@30669 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-01 00:33:23 +00:00
Drew Jaynes 78bb3e5ff5 Docs Formatting: Backtick-escape inline code for all dynamic hook docs in wp-admin/includes/*.
Also adds a few inline `@see` cross-references as they apply.

Affects DocBlocks for the following hooks:
* `views_{$this->screen->id}`
* `bulk_actions-{$this->screen->id}`
* `manage_{$this->screen->id}_sortable_columns`
* `theme_action_links_$stylesheet`
* `after_theme_row_$stylesheet`
* `install_plugins_table_api_args_$tab`
* `$prefix . plugin_action_links`
* `after_plugin_row_$plugin_file`
* `manage_taxonomies_for_{$post_type}_columns`
* `manage_{$post_type}_posts_columns`
* `manage_{$post->post_type}_posts_custom_column`
* `{$taxonomy}_row_actions`
* `manage_{$this->screen->taxonomy}_custom_column`
* `install_themes_table_api_args_' . $tab`
* `auto_update_ . $type`
* `{$action}_prefilter`
* `admin_head_{$content_func}`
* `nav_menu_items_{$post_type_name}`
* `activate_ . $plugin`
* `deactivate_ . $plugin`
* `edit_{$post_type}_per_page`
* `postbox_classes_{$page}_{$id}`
* `_wp_post_revision_field_$field`
* `manage_{$screen->id}_columns`
* `in_plugin_update_message-{$file}`
* `in_theme_update_message-{$theme_key}`

See #30552.

Built from https://develop.svn.wordpress.org/trunk@30648


git-svn-id: http://core.svn.wordpress.org/trunk@30638 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-30 11:28:24 +00:00
Drew Jaynes 4432dc752b 4.1 Docs Audit: Various formatting fixes for inline documentation in class-wp-list-table.php and comment-template.php.
See #30469.

Built from https://develop.svn.wordpress.org/trunk@30610


git-svn-id: http://core.svn.wordpress.org/trunk@30600 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-28 11:22:23 +00:00
Drew Jaynes 273396fe1e Ensure inline code is markdown-escaped as such, and that code snippets in descriptions are properly indented.
Affects DocBlocks for the following core elements:
* Backtick-escapes a `<link>` tag in a parameter description for the `embed_oembed_discover` hook
* Inline code fixes in the summary and return description for `WP_List_Table::get_table_classes()`
* Removes HTML markup from the summary for `WP_List_Table::display_rows_or_placeholder()`
* Backtick-escapes a `<tr>` tag in a parameter description for `WP_Users_List_Table::single_row()`
* Converts non-DocBlocks into multi-line comments in `WP_Dependencies::do_items()`
* Removes HTML markup from the summary for the `comment_form_top` hook.
* Inline code and snippet fixes in the description for `wp_get_schedules()`

Props rarst for the initial patch.
See #30473.

Built from https://develop.svn.wordpress.org/trunk@30537


git-svn-id: http://core.svn.wordpress.org/trunk@30526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-24 04:58:22 +00:00
Drew Jaynes 7081b906f4 Fix a couple of typos in the hook documentation for the `$option` filter in wp-admin/includes/class-wp-list-table.php.
Props bobbingwide.
Fixes #30229.

Built from https://develop.svn.wordpress.org/trunk@30227


git-svn-id: http://core.svn.wordpress.org/trunk@30227 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-04 16:05:22 +00:00
Drew Jaynes 256bea185d Add parameter and return descriptions to the `WP_List_Table::get_pagination_arg()` DocBlock.
See #30224.

Built from https://develop.svn.wordpress.org/trunk@30225


git-svn-id: http://core.svn.wordpress.org/trunk@30225 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-04 15:55:23 +00:00
Scott Taylor 4d0f66854a Fix the return value doc for `WP_List_Table->get_pagination_arg()`.
See #30224.

Built from https://develop.svn.wordpress.org/trunk@30169


git-svn-id: http://core.svn.wordpress.org/trunk@30169 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-01 23:00:23 +00:00
Scott Taylor 0b9c1be743 In `WP_List_Table`, add a property, `$modes`, to allow `WP_Media_List_Table` to inherit `->view_switcher()`.
See #30224.

Built from https://develop.svn.wordpress.org/trunk@30154


git-svn-id: http://core.svn.wordpress.org/trunk@30154 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-01 19:56:24 +00:00
Drew Jaynes f8657d5890 Remove redundant and erroneous `@uses` tag from most core inline documentation.
Per our inline documentation standards, no further use of the `@uses` tag is recommended as used and used-by relationships can be derived through other means. This removes most uses of the tag in core documentation, with remaining tags to be converted to `@global` or `@see` as they apply.

Fixes #30191.

Built from https://develop.svn.wordpress.org/trunk@30105


git-svn-id: http://core.svn.wordpress.org/trunk@30105 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-30 01:05:24 +00:00
Gary Pendergast 007ec52958 Add `wp_json_encode()`, a wrapper for `json_encode()` that ensures everything is converted to UTF-8.
Change all core calls from `json_encode()` to `wp_json_encode()`.

Fixes #28786.


Built from https://develop.svn.wordpress.org/trunk@30055


git-svn-id: http://core.svn.wordpress.org/trunk@30055 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-28 18:35:19 +00:00
Andrew Nacin f7392ef917 Pinking shears.
Built from https://develop.svn.wordpress.org/trunk@29707


git-svn-id: http://core.svn.wordpress.org/trunk@29481 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-09-04 15:23:16 +00:00
Drew Jaynes d60a081137 Add `@access` tags to constructor docblocks in list table classes.
See #28679. See [29459].

Built from https://develop.svn.wordpress.org/trunk@29460


git-svn-id: http://core.svn.wordpress.org/trunk@29238 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-10 02:22:16 +00:00
Drew Jaynes 8e86454467 Document default arguments for the `WP_List_Table` class. Also add referenced docblocks to extending class constructors.
Props mikejolley for the initial patch.
Fixes #28679. See #28298.

Built from https://develop.svn.wordpress.org/trunk@29459


git-svn-id: http://core.svn.wordpress.org/trunk@29237 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-10 02:18:17 +00:00
Drew Jaynes a8583d5f19 Fix some words that aren't words.
See #28885.

Built from https://develop.svn.wordpress.org/trunk@29454


git-svn-id: http://core.svn.wordpress.org/trunk@29232 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-09 19:30:17 +00:00
Scott Taylor 704a4c4803 Mark `WP_List_Table::bulk_actions()`'s argument `$which` as optional for BC.
Fixes #29026.

Built from https://develop.svn.wordpress.org/trunk@29440


git-svn-id: http://core.svn.wordpress.org/trunk@29218 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-07 21:30:15 +00:00
Scott Taylor ce7955cc9e Add screen reader text to list table date dropdown.
See #29026.

Built from https://develop.svn.wordpress.org/trunk@29433


git-svn-id: http://core.svn.wordpress.org/trunk@29211 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-07 19:44:15 +00:00
Scott Taylor c5dff42d51 Revert [29428] to avoid errors with Add Media for now.
See #29026.

Built from https://develop.svn.wordpress.org/trunk@29432


git-svn-id: http://core.svn.wordpress.org/trunk@29210 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-07 19:40:15 +00:00
Scott Taylor afb0b3e4ef Media Grid: add screen reader labels with more context to filters and bulk actions. Ditto for list view.
Props afercia.
Fixes #29026.

Built from https://develop.svn.wordpress.org/trunk@29428


git-svn-id: http://core.svn.wordpress.org/trunk@29206 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-07 05:20:16 +00:00
Scott Taylor 64407235a9 `WP_List_Table::items` should be `public`, not `protected`. It is accessed in a subclass directly via `wp_ajax_get_comments()`.
See [28493].
Fixes #29072.

Built from https://develop.svn.wordpress.org/trunk@29423


git-svn-id: http://core.svn.wordpress.org/trunk@29201 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-07 02:51:16 +00:00
Dominik Schilling 7a67693b37 Add missing `screen-reader-text` CSS class in [29294].
see #28867.
Built from https://develop.svn.wordpress.org/trunk@29308


git-svn-id: http://core.svn.wordpress.org/trunk@29090 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-27 13:43:17 +00:00
Scott Taylor 97fff7e952 Adds `<label>`s to current page selector and bulk actions `<select>` field so that screen readers have an explicit label.
Props joedolson.
Fixes #28867.

Built from https://develop.svn.wordpress.org/trunk@29294


git-svn-id: http://core.svn.wordpress.org/trunk@29076 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-25 00:20:16 +00:00
Drew Jaynes 097dc8ee15 Fix syntax for single- and multi-line comments in wp-admin-directory files.
See #28931.

Built from https://develop.svn.wordpress.org/trunk@29206


git-svn-id: http://core.svn.wordpress.org/trunk@28990 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-17 09:14:16 +00:00
Drew Jaynes 9ae01ba532 Fix a typo in the `@access` tag for `WP_List_Table::__get()`.
Props joehoyle.
Fixes #28925. See #28885.

Built from https://develop.svn.wordpress.org/trunk@29199


git-svn-id: http://core.svn.wordpress.org/trunk@28983 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-16 22:13:14 +00:00
Drew Jaynes 90d7cc27c2 Fill out inline documentation for magic methods added to the `WP_List_Table` class in [28493], [28521], and [28524].
See #22234 and #28885.

Built from https://develop.svn.wordpress.org/trunk@29148


git-svn-id: http://core.svn.wordpress.org/trunk@28932 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-13 23:55:16 +00:00
Scott Taylor 176b9b2301 Fix mismatches in access modifiers for `WP_List_Table` + subclasses.
Fixes #28843, #28879.

Built from https://develop.svn.wordpress.org/trunk@29137


git-svn-id: http://core.svn.wordpress.org/trunk@28921 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-13 22:09:16 +00:00
Dominik Schilling 6ef23ea006 Lists View Switcher: Replace blank image with screen reader text.
props davidakennedy.
fixes #28871.
Built from https://develop.svn.wordpress.org/trunk@29133


git-svn-id: http://core.svn.wordpress.org/trunk@28918 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-13 11:05:15 +00:00
Scott Taylor 40725e9e67 Repent for our original OOP sins and doc blocks as pertains to access modifiers in List Table + subclasses.
Props SergeyBiryukov.
See #28843 and [28583].

Built from https://develop.svn.wordpress.org/trunk@29118


git-svn-id: http://core.svn.wordpress.org/trunk@28904 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-12 03:27:14 +00:00
Drew Jaynes d4dd02b4ae Remove backticks on `$post` variables in some short parameter descriptions.
See [28653], [28654].
See #28388.

Built from https://develop.svn.wordpress.org/trunk@28976


git-svn-id: http://core.svn.wordpress.org/trunk@28765 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-03 19:28:14 +00:00
Sergey Biryukov 5f0b156155 Prevent bulk actions from being performed when Filter button is clicked.
props jesin.
fixes #28555.
Built from https://develop.svn.wordpress.org/trunk@28916


git-svn-id: http://core.svn.wordpress.org/trunk@28715 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-30 01:10:15 +00:00
Sergey Biryukov 5bd180bcbd Revert [28766].
see #28555.
Built from https://develop.svn.wordpress.org/trunk@28772


git-svn-id: http://core.svn.wordpress.org/trunk@28585 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-18 02:23:13 +00:00
Sergey Biryukov cd7618399e Prevent bulk actions from being performed when Filter button is clicked.
props layotte.
fixes #28555.
Built from https://develop.svn.wordpress.org/trunk@28766


git-svn-id: http://core.svn.wordpress.org/trunk@28579 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-17 22:17:14 +00:00
Helen Hou-Sandí b5ef672c6b Grid view for the media library, first pass. This is alpha; expect imperfection. We will be iterating further.
props ericlewis, shaunandrews, wonderboymusic.
see #24716.

Built from https://develop.svn.wordpress.org/trunk@28682


git-svn-id: http://core.svn.wordpress.org/trunk@28500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-05 22:01:18 +00:00
Scott Taylor 85f73cf458 Classes that have `__set()` also need `__isset()` and `__unset()`.
See #27881, #22234.

Built from https://develop.svn.wordpress.org/trunk@28524


git-svn-id: http://core.svn.wordpress.org/trunk@28350 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 06:52:14 +00:00
Scott Taylor 821246b4ae Some classes with `__get()` method also need `__set()`.
See #27881, #22234.

Built from https://develop.svn.wordpress.org/trunk@28521


git-svn-id: http://core.svn.wordpress.org/trunk@28347 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 06:31:15 +00:00
Scott Taylor 2f513d3320 Fix some `hackificator` odds and ends in `wp-admin`:
* `wp-activate.php` and `wp-admin/themes.php` don't need the closing PHP tag
* Switch single quotes for HTML attribute values to double in a few places
* Convert `include_once file.php` syntax to `include_once( 'file.php' )`
* Add access modifiers to methods/members in: `_WP_List_Table_Compat`, `Walker_Nav_Menu_Edit`, `Walker_Nav_Menu_Checklist`, `WP_Screen`, `Walker_Category_Checklist`
* `edit_user()` doesn't need to import the `$wpdb` global
* `wp_list_widgets()` doesn't need to import the `$sidebars_widgets` global
* switch/endswitch syntax is not supported in Hack
* A `<ul>` in `wp-admin/users.php` is unclosed

See #27881.

Built from https://develop.svn.wordpress.org/trunk@28500


git-svn-id: http://core.svn.wordpress.org/trunk@28326 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 05:04:16 +00:00
Scott Taylor 130771a383 `hackificator` doesn't like mixed quote styles in some generated HTML. The switch from single to double allows these files to be parsed.
See #27881.

Built from https://develop.svn.wordpress.org/trunk@28497


git-svn-id: http://core.svn.wordpress.org/trunk@28323 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 01:59:15 +00:00
Scott Taylor d28f6344de Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`

See #27881, #22234.

Built from https://develop.svn.wordpress.org/trunk@28493


git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 01:17:15 +00:00
Scott Taylor aef35fe6a2 Eliminate use of `extract()` in `WP_List_Table::pagination()`:
* Set variables instead of extracting `$this->_pagination_args`
* Weird: `$infinite_scroll` is only presently set in subclasses of `WP_List_Table` and never initialized otherwise. 		

See #22400.

Built from https://develop.svn.wordpress.org/trunk@28389


git-svn-id: http://core.svn.wordpress.org/trunk@28217 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-13 05:27:14 +00:00
Scott Taylor 192e235672 Eliminate use of `extract()` in `WP_List_Table::ajax_response()`:
* Extracting `$this->_args` is unnecessary since none of the variables produced are present in the method.
* `total_items` and `total_pages` can be read directly from `$this->_pagination_args`

See #22400.

Built from https://develop.svn.wordpress.org/trunk@28387


git-svn-id: http://core.svn.wordpress.org/trunk@28215 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-13 05:14:14 +00:00
Scott Taylor 08d73b9e23 Eliminate use of `extract()` in `WP_List_Table::display()`. The method only needs to read `singular` from `$this->_args`. Extraction is unnecessary.
See #22400.

Built from https://develop.svn.wordpress.org/trunk@28386


git-svn-id: http://core.svn.wordpress.org/trunk@28214 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-13 05:08:13 +00:00
Scott Taylor ded4871368 In `WP_List_Table::display_rows_or_placeholder()`, the call to `get_column_info()` in unnecessary and unused. The call to `get_column_count()` immediately after makes the same call internally.
See #27882.


Built from https://develop.svn.wordpress.org/trunk@28279


git-svn-id: http://core.svn.wordpress.org/trunk@28107 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-06 05:32:15 +00:00
Dominik Schilling d1f3abe55c Remove "Show" prefix from filter dropdowns, see #26743.
Built from https://develop.svn.wordpress.org/trunk@27626


git-svn-id: http://core.svn.wordpress.org/trunk@27469 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-03-19 22:13:14 +00:00
Sergey Biryukov f29df4f74c Remove duplicate description of WP_List_Table class.
props bravokeyl.
fixes #27346.
Built from https://develop.svn.wordpress.org/trunk@27502


git-svn-id: http://core.svn.wordpress.org/trunk@27345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-03-11 16:23:15 +00:00
Andrew Ozz 87589dd445 Remove table cellspacing attribute from the admin, part-props MattyRob, fixes #22086.
Built from https://develop.svn.wordpress.org/trunk@27036


git-svn-id: http://core.svn.wordpress.org/trunk@26912 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-01-26 20:28:12 +00:00
Drew Jaynes 73f42e01a2 Inline documentation for hooks in wp-admin/includes/class-wp-list-table.php.
Props miyauchi, kpdesign.
Fixes 25848.

Built from https://develop.svn.wordpress.org/trunk@26401


git-svn-id: http://core.svn.wordpress.org/trunk@26301 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-26 08:12:09 +00:00
Helen Hou-Sandí 9796e54574 Saner CSS for row actions - now we can just target `.row-actions` instead of both `.row-actions` and `.row-actions-visible`. CSS for `.row-actions-visible` remains for now due to usage in plugins. Visibility is controlled by toggling a `.visible` class. fixes #25403.
Built from https://develop.svn.wordpress.org/trunk@25592


git-svn-id: http://core.svn.wordpress.org/trunk@25509 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-24 01:54:09 +00:00
Drew Jaynes c5abe8acaa Make the `WP_List_Table::months_dropdown()` query results filterable.
Introduces the `months_dropdown_results` filter.

Fixes #17022.

Built from https://develop.svn.wordpress.org/trunk@25556


git-svn-id: http://core.svn.wordpress.org/trunk@25476 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-21 18:35:09 +00:00
Helen Hou-Sandí 6c121d303d Add a class to the bulk actions wrapper div. props nofearinc. fixes #25197.
Built from https://develop.svn.wordpress.org/trunk@25509


git-svn-id: http://core.svn.wordpress.org/trunk@25429 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-19 21:01:09 +00:00