Commit Graph

51 Commits

Author SHA1 Message Date
Sergey Biryukov
180e7a2721 Coding Standards: Use strict comparison in wp-admin/includes/screen.php.
See #52627.

git-svn-id: https://develop.svn.wordpress.org/trunk@50832 602fd350-edb4-49c9-b593-d223f7449a82
2021-05-09 20:25:41 +00:00
John Blackbourn
5e35ad2510 Docs: Various formatting improvements to inline docblocks.
See #49572

git-svn-id: https://develop.svn.wordpress.org/trunk@48574 602fd350-edb4-49c9-b593-d223f7449a82
2020-07-23 00:50:57 +00:00
Sergey Biryukov
cdf3431ac9 Docs: Remove @staticvar tags from core.
The tag was supported in phpDocumentor 1.x, but is no longer supported in 2.x and 3.x.

Usage of static variables is considered an internal implementation detail and has no information value for someone reading the docs.

Props alishanvr, jrf.
Fixes #50426.

git-svn-id: https://develop.svn.wordpress.org/trunk@48109 602fd350-edb4-49c9-b593-d223f7449a82
2020-06-20 12:38:55 +00:00
Sergey Biryukov
6742d0d7a6 Coding Standards: Use strict comparison where static strings are involved.
This reduces the number of `WordPress.PHP.StrictComparisons.LooseComparison` issues in half, from 1897 to 890.

Includes minor code layout fixes for better readability.

See #49542.

git-svn-id: https://develop.svn.wordpress.org/trunk@47808 602fd350-edb4-49c9-b593-d223f7449a82
2020-05-16 18:40:52 +00:00
Sergey Biryukov
d8c502e966 Coding Standards: Use strict type check for in_array() and array_search().
This addresses all the remaining `WordPress.PHP.StrictInArray.MissingTrueStrict` issues in core.

Includes minor code layout fixes for better readability.

Follow-up to [47550].

See #49542.

git-svn-id: https://develop.svn.wordpress.org/trunk@47557 602fd350-edb4-49c9-b593-d223f7449a82
2020-04-09 15:41:04 +00:00
Sergey Biryukov
0b4e2c4604 Coding Standards: Use strict type check for in_array() and array_search() where strings are involved.
This reduces the number of `WordPress.PHP.StrictInArray.MissingTrueStrict` issues from 486 to 50.

Includes minor code layout fixes for better readability.

See #49542.

git-svn-id: https://develop.svn.wordpress.org/trunk@47550 602fd350-edb4-49c9-b593-d223f7449a82
2020-04-05 03:00:44 +00:00
Sergey Biryukov
cfc3b57488 Docs: Improve inline comments per the documentation standards.
Includes minor code layout fixes for better readability.

See #48303.

git-svn-id: https://develop.svn.wordpress.org/trunk@47122 602fd350-edb4-49c9-b593-d223f7449a82
2020-01-29 00:43:23 +00:00
John Blackbourn
e12f866db2 Docs: Further docblock corrections and improvements.
See #48303

git-svn-id: https://develop.svn.wordpress.org/trunk@46826 602fd350-edb4-49c9-b593-d223f7449a82
2019-12-07 13:21:07 +00:00
John Blackbourn
46581088d5 Docs: Docs on docs. Further improve documentation of known return types, plus other docs fixes.
See #48303


git-svn-id: https://develop.svn.wordpress.org/trunk@46662 602fd350-edb4-49c9-b593-d223f7449a82
2019-11-05 21:28:51 +00:00
John Blackbourn
4f281f1650 Docs: Switch more docs over to typed array notation, plus some fixes.
See #48303, #41756


git-svn-id: https://develop.svn.wordpress.org/trunk@46596 602fd350-edb4-49c9-b593-d223f7449a82
2019-10-26 21:07:10 +00:00
Sergey Biryukov
a7b20de958 Docs: Add missing description for $current_screen global.
Props mukesh27.
Fixes #45604. See #47110.

git-svn-id: https://develop.svn.wordpress.org/trunk@45740 602fd350-edb4-49c9-b593-d223f7449a82
2019-08-04 02:02:10 +00:00
Gary Pendergast
8f95800d52 Code is Poetry.
WordPress' code just... wasn't.
This is now dealt with.

Props jrf, pento, netweb, GaryJ, jdgrimes, westonruter, Greg Sherwood from PHPCS, and everyone who's ever contributed to WPCS and PHPCS.
Fixes #41057.



git-svn-id: https://develop.svn.wordpress.org/trunk@42343 602fd350-edb4-49c9-b593-d223f7449a82
2017-11-30 23:09:33 +00:00
Dominik Schilling
535f0e3090 Screen API: After [37972], ensure that $box['args'] is an array before trying to access __widget_basename.
This prevents a PHP fatal error on the Nav Menus screen where `$args` is an object.

Props elrae.
Fixes #35021.

git-svn-id: https://develop.svn.wordpress.org/trunk@38004 602fd350-edb4-49c9-b593-d223f7449a82
2016-07-07 16:38:28 +00:00
Dominik Schilling
d9de76e2a7 Dashboard: Don't add a "Configure" link to the toggle button.
The HTML for the toggle gets appended to the widget name which is later used for the widget title and the screen reader text of the toggle button. Storing the original widget name in the arguments allows us to use the name without the HTML for the screen reader text and doesn't require further changes by plugin developers.

Props nicholas_io, swissspidy.
Fixes #35021.

git-svn-id: https://develop.svn.wordpress.org/trunk@37972 602fd350-edb4-49c9-b593-d223f7449a82
2016-07-05 15:21:44 +00:00
Drew Jaynes
08a0225d5c Docs: Update the return notation for get_current_screen() to note that null can also be returned if the screen has not been defined.
Props screamingdev.
Fixes #36382.


git-svn-id: https://develop.svn.wordpress.org/trunk@37534 602fd350-edb4-49c9-b593-d223f7449a82
2016-05-23 16:33:22 +00:00
Drew Jaynes
1cd420af5e Docs: Standardize hook docs in wp-admin/* to use third-person singular verbs per the inline documentation standards for PHP.
See #36913.


git-svn-id: https://develop.svn.wordpress.org/trunk@37488 602fd350-edb4-49c9-b593-d223f7449a82
2016-05-22 18:00:23 +00:00
Dominik Schilling (ocean90)
d47319710c Docs: Remove indentation from the hidden_columns changelog entry.
Added in [36154].

See #35057.

git-svn-id: https://develop.svn.wordpress.org/trunk@36156 602fd350-edb4-49c9-b593-d223f7449a82
2016-01-02 15:15:53 +00:00
Dion Hulse
84cb626eb6 List Tables: When a user has hidden all columns, do not override that with the default_hidden_columns filter.
Props Compute, jorbin, voldemortensen.
Fixes #35057


git-svn-id: https://develop.svn.wordpress.org/trunk@36154 602fd350-edb4-49c9-b593-d223f7449a82
2016-01-02 04:43:07 +00:00
Scott Taylor
ac610c191b Move WP_Screen to its own file.
See #33413.


git-svn-id: https://develop.svn.wordpress.org/trunk@34169 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-15 04:07:14 +00:00
Weston Ruter
fd1dbfe003 Customize: Remove redundant aria-label attributes.
Adds an `$options` array argument to `WP_Screen::render_screen_options()` to allow the `div#screen-options-wrap` element to be omitted when `wrap` value is `false`.

Props afercia, westonruter.
Fixes #33182.


git-svn-id: https://develop.svn.wordpress.org/trunk@34093 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-13 06:15:42 +00:00
Scott Taylor
6bc498c0e6 Implement a priority system for Help Tabs to add them at specific positions.
Adds unit tests.

Props swissspidy.
Fixes #19828.


git-svn-id: https://develop.svn.wordpress.org/trunk@33985 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-10 01:26:26 +00:00
Helen Hou-Sandi
961dd71cf3 List tables: Allow filtering of hidden and default hidden columns.
Similar to `get_hidden_meta_boxes()`, there are now filters named `default_hidden_columns` and `hidden_columns`.

props Compute, MikeHansenMe, chriscct7.
fixes #32499.


git-svn-id: https://develop.svn.wordpress.org/trunk@33689 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-21 15:31:30 +00:00
Konstantin Obenland
9bf79ed862 Semanticize Help and Screen Options toggle.
Links used as UI controls that are not real links but act as buttons, should be buttons.

Props afercia.
Fixes #32494.



git-svn-id: https://develop.svn.wordpress.org/trunk@32844 602fd350-edb4-49c9-b593-d223f7449a82
2015-06-18 16:35:12 +00:00
Konstantin Obenland
99d0d85fb0 Sort screen options for meta boxes according to the meta box's priority.
Props swissspidy.
Fixes #32582.



git-svn-id: https://develop.svn.wordpress.org/trunk@32707 602fd350-edb4-49c9-b593-d223f7449a82
2015-06-08 12:34:03 +00:00
Scott Taylor
60e5c90e62 Add (more) missing doc blocks to wp-admin/includes/*.
See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32655 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-29 21:16:59 +00:00
Scott Taylor
c8a44d437a Add @static* annotations where they are missing.
Initialize all static vars that are not, most to `null`.

See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32650 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-29 15:42:40 +00:00
Scott Taylor
f864c1d712 Add @global annotations to (the rest of the?) wp-admin/* files.
Does not include list table file changes.

See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32643 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-29 02:05:26 +00:00
Dominik Schilling (ocean90)
3bb3d2f1a5 Screen Options: Improve items per page option label.
Previously the label just said "Posts", "Pages", or "Comments". This was bad in terms of accessibility and internationalization because of missing context.
This change adds a default label "Number of items per page:" to `WP_Screen->render_per_page_options()` and removes all the existing one-word labels.

props afercia.
fixes #31349, #15576.

git-svn-id: https://develop.svn.wordpress.org/trunk@31696 602fd350-edb4-49c9-b593-d223f7449a82
2015-03-10 15:31:54 +00:00
Scott Taylor
83b6fad852 In HTML5, the action attribute is no longer required. Remove this attribute when empty.
The admin HTML is served with the HTML5 doctype.

"The action and formaction content attributes, if specified, must have a value that is a valid non-empty URL potentially surrounded by spaces." 
http://www.w3.org/html/wg/drafts/html/master/forms.html#attr-fs-action

Props voldemortensen.
Fixes #30126.


git-svn-id: https://develop.svn.wordpress.org/trunk@31200 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-16 04:15:52 +00:00
Scott Taylor
5acc6bdb58 In PHP 5.0.0, is_a() became deprecated in favour of the instanceof operator. Calling is_a() would result in an E_STRICT warning.
In PHP 5.3.0, `is_a()` is no longer deprecated, and will therefore no longer throw `E_STRICT` warnings.

To avoid warnings in PHP < 5.3.0, convert all `is_a()` calls to `$var instanceof WP_Class` calls.

`instanceof` does not throw any error if the variable being tested is not an object, it simply returns `false`.

Props markoheijnen, wonderboymusic.
Fixes #25672.


git-svn-id: https://develop.svn.wordpress.org/trunk@31188 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-16 01:05:52 +00:00
Scott Taylor
f6f12912e2 Improve some docs for @param. Remove an unneeded $wpdb global import.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@30979 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-20 20:55:21 +00:00
Andrew Ozz
86c494d1b5 Update better description of the Screen Options checkbox for DFW v2 and editor-expand. Props johnbillion, kpdesign, fixes #30557.
git-svn-id: https://develop.svn.wordpress.org/trunk@30734 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-03 21:59:53 +00:00
Andrew Ozz
9adaec183e Update the description of the Screen Options checkbox for turning editor-expand on/off to include DFW v2. Props kpdesign, fixes #30557.
git-svn-id: https://develop.svn.wordpress.org/trunk@30718 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-02 23:22:52 +00:00
Scott Taylor
8a4fa5662b Improve various @param docs for src/wp-admin/*.
See #30224.


git-svn-id: https://develop.svn.wordpress.org/trunk@30680 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-01 00:59:43 +00:00
Drew Jaynes (DrewAPicture)
f45fd382b3 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@30648 602fd350-edb4-49c9-b593-d223f7449a82
2014-11-30 11:27:19 +00:00
Drew Jaynes (DrewAPicture)
e4bebb4089 Fix parameter description syntax for WP_Screen::get_option().
Props zrothauser for the initial patch.
See [30368]. Fixes #30363.


git-svn-id: https://develop.svn.wordpress.org/trunk@30369 602fd350-edb4-49c9-b593-d223f7449a82
2014-11-17 17:10:56 +00:00
Drew Jaynes (DrewAPicture)
e6538f5e00 Add a missing @return description for WP_Screen::get_option().
Also declare the default value for the `$key` parameter.

Props dustyf for the initial patch.
Fixes #30363.


git-svn-id: https://develop.svn.wordpress.org/trunk@30368 602fd350-edb4-49c9-b593-d223f7449a82
2014-11-17 17:07:19 +00:00
Drew Jaynes (DrewAPicture)
3cc10d77a0 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@30105 602fd350-edb4-49c9-b593-d223f7449a82
2014-10-30 01:04:55 +00:00
Andrew Nacin
50706e736d Screen: Move editor scrolling screen option to the proper place.
see [29336], see #28328.


git-svn-id: https://develop.svn.wordpress.org/trunk@29588 602fd350-edb4-49c9-b593-d223f7449a82
2014-08-24 17:56:25 +00:00
Andrew Ozz
c94edd08bd Editor scrolling:
- Add a Screen Option to turn it on/off, and on()/off() methods from JS. Store the user preference.
- Fix delayed calls to resize() in the TinyMCE autoresize plugin.
See #28328.

git-svn-id: https://develop.svn.wordpress.org/trunk@29336 602fd350-edb4-49c9-b593-d223f7449a82
2014-08-01 02:42:30 +00:00
Helen Hou-Sandi
5698a9dc7e Media Grid: Remove fields from showing in the grid itself.
All details are still available within the modal, and less-distinguishable non-image files still show the filename along with the file type icon.

Reverts [29079], [29078], [29077], and [28995]. see #24716.


git-svn-id: https://develop.svn.wordpress.org/trunk@29280 602fd350-edb4-49c9-b593-d223f7449a82
2014-07-24 05:25:28 +00:00
Scott Taylor
ee0e7ccbca Media Grid: make registering Screen Options for non-list tables more generic.
See #24716.


git-svn-id: https://develop.svn.wordpress.org/trunk@29079 602fd350-edb4-49c9-b593-d223f7449a82
2014-07-10 21:43:49 +00:00
Scott Taylor
d5cbf00457 Media Grid: Screen Options for grid have to play nice with Screen Options for list. This was fun.
See #24716.


git-svn-id: https://develop.svn.wordpress.org/trunk@29078 602fd350-edb4-49c9-b593-d223f7449a82
2014-07-10 21:25:49 +00:00
Scott Taylor
3ebde0c4d6 Media Grid: Move toggling of visible fields to Screen Options. This moves us in a better direction... but this will probably need to be massaged again.
See #24716.


git-svn-id: https://develop.svn.wordpress.org/trunk@29077 602fd350-edb4-49c9-b593-d223f7449a82
2014-07-10 20:59:12 +00:00
Scott Taylor
e43d2a73d8 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@28500 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-19 05:03:44 +00:00
Drew Jaynes (DrewAPicture)
bbd130fe15 Use interpolation instead of concatenation for the manage_{$screen->id}_columns hook name.
Props Otto42.
See #26869.


git-svn-id: https://develop.svn.wordpress.org/trunk@28348 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-08 09:57:11 +00:00
Scott Taylor
fb1054340f In WP_Screen::render_screen_options(), remove dead code:
* `$wp_list_table` does not need to be imported.
* `$post` is set and never used.

See #27882.


git-svn-id: https://develop.svn.wordpress.org/trunk@28303 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-06 17:13:30 +00:00
Drew Jaynes
2aa5387801 Inline documentation for hooks in wp-admin/includes/screen.php.
Props enej, kpdesign.
Fixes #26821.


git-svn-id: https://develop.svn.wordpress.org/trunk@27256 602fd350-edb4-49c9-b593-d223f7449a82
2014-02-25 10:04:46 +00:00
Andrew Ozz
b33d0da84c Remove all screen_icon() calls and deprecate the functions, props TobiasBg, fixes #26119
git-svn-id: https://develop.svn.wordpress.org/trunk@26518 602fd350-edb4-49c9-b593-d223f7449a82
2013-12-02 03:52:23 +00:00
Helen Hou-Sandi
eaa7c65263 Add remove_option(), remove_options(), and get_options() methods to WP_Screen, along with unit tests. props ocean90, DrewAPicture. fixes #25799.
git-svn-id: https://develop.svn.wordpress.org/trunk@26456 602fd350-edb4-49c9-b593-d223f7449a82
2013-11-28 05:09:06 +00:00