be4b739a49
Docs: Fix a few more typos in inline comments.
...
Follow-up to [9117], [11005], [12097], [18632], [26192], [55823].
Props Presskopp.
See #58334 , #57840 .
Built from https://develop.svn.wordpress.org/trunk@55824
git-svn-id: http://core.svn.wordpress.org/trunk@55336 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-05-18 12:36:24 +00:00
bd393654cc
Filesystem API: Correct and improve the return type documentation for the `dirlist()` method in `WP_Filesystem_Base` and its extending classes.
...
Props mat-lipe, szepeviktor, costdev, audrasjb, johnbillion
Fixes #58229
See #57840
Built from https://develop.svn.wordpress.org/trunk@55714
git-svn-id: http://core.svn.wordpress.org/trunk@55226 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-05-03 21:30:19 +00:00
c03305852e
Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes.
...
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
There are a number of ways to mitigate this:
* If it is an accidental typo for a declared property: fix the typo.
* For known properties: declare them on the class.
* For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in.
* For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes.
Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1.
To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, this commit adds the `#[AllowDynamicProperties]` attribute to all “parent” classes in WP.
The logic used for this commit is as follows:
* If a class already has the attribute: no action needed.
* If a class does not `extend`: add the attribute.
* If a class does `extend`:
- If it extends `stdClass`: no action needed (as `stdClass` supports dynamic properties).
- If it extends a PHP native class: add the attribute.
- If it extends a class from one of WP's external dependencies: add the attribute.
* In all other cases: no action — the attribute should not be needed as child classes inherit from the parent.
Whether or not a class contains magic methods has not been taken into account, as a review of the currently existing magic methods has shown that those are generally not sturdy enough and often even set dynamic properties (which they should not). See the [https://www.youtube.com/watch?v=vDZWepDQQVE live stream from August 16, 2022] for more details.
This commit only affects classes in the `src` directory of WordPress core.
* Tests should not get this attribute, but should be fixed to not use dynamic properties instead. Patches for this are already being committed under ticket #56033 .
* While a number bundled themes (2014, 2019, 2020, 2021) contain classes, they are not a part of this commit and may be updated separately.
Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties].
Follow-up to [53922].
Props jrf, hellofromTonya, markjaquith, peterwilsoncc, costdev, knutsp, aristath.
See #56513 , #56034 .
Built from https://develop.svn.wordpress.org/trunk@54133
git-svn-id: http://core.svn.wordpress.org/trunk@53692 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-12 15:47:14 +00:00
16bc8d38a6
Coding Standards: Use a consistent markup for line break tags across Core.
...
This changeset replaces `<br/>` with `<br />` on various places, as per WordPress Coding Standards.
See https://developer.wordpress.org/coding-standards/wordpress-coding-standards/html/#self-closing-elements
Props haritpanchal, costdev, audrasjb.
Fixes #56457 .
Built from https://develop.svn.wordpress.org/trunk@54062
git-svn-id: http://core.svn.wordpress.org/trunk@53621 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-02 06:51:13 +00:00
c3783c9f3a
Coding Standards: Rename the `$file` parameter to `$path` in some `WP_Filesystem_*` methods.
...
This aims to bring more clarity to the code, and applies to methods where the path can be a file or a directory:
* `WP_Filesystem_*::exists()`
* `WP_Filesystem_*::is_writable()`
Follow-up to [6779], [25560].
See #55647 .
Built from https://develop.svn.wordpress.org/trunk@53872
git-svn-id: http://core.svn.wordpress.org/trunk@53431 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-08-09 11:33:10 +00:00
1aaf68db85
Code Modernization: Rename parameters that use reserved keywords in `wp-admin/includes/class-wp-filesystem-base.php`.
...
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$echo` parameter to `$verbose` in `WP_Filesystem_Base::find_base_dir()` and `::get_base_dir()`, and updates the documentation accordingly. This matches the class property of the same name.
Follow-up to [52946], [52996], [52997], [52998], [53003].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327 .
Built from https://develop.svn.wordpress.org/trunk@53014
git-svn-id: http://core.svn.wordpress.org/trunk@52603 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-03-29 13:21:08 +00:00
39bff93b6b
Docs: Various inline documentation corrections and improvements.
...
See #53399
Built from https://develop.svn.wordpress.org/trunk@52332
git-svn-id: http://core.svn.wordpress.org/trunk@51924 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-12-07 12:20:02 +00:00
1e6a658e2f
Docs: Clarify the `@return` value for `WP_Filesystem_Base::getnumchmodfromh()`.
...
Follow-up to [9117], [51494].
See #53399 .
Built from https://develop.svn.wordpress.org/trunk@51495
git-svn-id: http://core.svn.wordpress.org/trunk@51106 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-27 11:01:57 +00:00
e86e6f8771
Docs: Correct `@return` type for `WP_Filesystem_Base::getnumchmodfromh()`.
...
Follow-up to [9117].
Props ankitmaru, johnbillion.
Fixes #53793 .
Built from https://develop.svn.wordpress.org/trunk@51494
git-svn-id: http://core.svn.wordpress.org/trunk@51105 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-27 09:29:01 +00:00
a338f84f32
Coding Standards: Use strict comparison in `wp-admin/includes/class-wp-filesystem-*.php`.
...
See #52627 .
Built from https://develop.svn.wordpress.org/trunk@50657
git-svn-id: http://core.svn.wordpress.org/trunk@50269 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-04-05 10:38:07 +00:00
b59c0f307b
Docs: Corrections and improvements to types used in various docblocks.
...
See #51800 , #52217
Built from https://develop.svn.wordpress.org/trunk@49936
git-svn-id: http://core.svn.wordpress.org/trunk@49635 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-01-05 17:16:11 +00:00
25b0783629
Docs: Correct references to `WP_Filesystem_Base` methods in various DocBlocks.
...
Props pbiron.
Fixes #51087 .
Built from https://develop.svn.wordpress.org/trunk@48835
git-svn-id: http://core.svn.wordpress.org/trunk@48597 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-08-21 00:43:05 +00:00
527696af3b
Coding Standards: Add some space around control structures in `WP_Filesystem_*` classes for consistency and better readability.
...
Additionally, synchronize `$tempfile` and `$temphandle` variable names in `WP_Filesystem_FTPext` and `WP_Filesystem_ftpsockets`.
See #49542 .
Built from https://develop.svn.wordpress.org/trunk@48089
git-svn-id: http://core.svn.wordpress.org/trunk@47856 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-19 10:36:12 +00:00
7932193708
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 .
Built from https://develop.svn.wordpress.org/trunk@47808
git-svn-id: http://core.svn.wordpress.org/trunk@47584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-05-16 18:42:12 +00:00
856e1a27b8
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 .
Built from https://develop.svn.wordpress.org/trunk@47557
git-svn-id: http://core.svn.wordpress.org/trunk@47332 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-04-09 15:43:10 +00:00
001ffe81fb
Docs: Improve inline comments per the documentation standards.
...
Includes minor code layout fixes for better readability.
See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47122
git-svn-id: http://core.svn.wordpress.org/trunk@46922 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-01-29 00:45:18 +00:00
2900bb8ea7
Docs: Update links to https://secure.php.net/ , they now redirect to https://www.php.net/ .
...
See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47088
git-svn-id: http://core.svn.wordpress.org/trunk@46888 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-01-20 03:14:06 +00:00
15a4289c8d
Docs: Correct description for `$recursive` parameter of `::chmod()` and `::delete()` methods in `WP_Filesystem` implementations.
...
Props skithund.
Fixes #48422 .
Built from https://develop.svn.wordpress.org/trunk@46679
git-svn-id: http://core.svn.wordpress.org/trunk@46479 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-08 22:56:02 +00:00
e199663322
I18N: Capitalize translator comments consistently, add trailing punctuation.
...
Includes minor code layout fixes.
See #44360 .
Built from https://develop.svn.wordpress.org/trunk@45932
git-svn-id: http://core.svn.wordpress.org/trunk@45743 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-03 00:41:05 +00:00
cf3fa9f7c8
Coding Standards: Fix the `Squiz.PHP.DisallowMultipleAssignments` violations in `wp-admin`.
...
See #47632 .
Built from https://develop.svn.wordpress.org/trunk@45583
git-svn-id: http://core.svn.wordpress.org/trunk@45394 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-01 12:52:01 +00:00
74e9c3d20d
Docs: Improve documentation for various `WP_Filesystem_Base` methods and extending classes.
...
Props jaydeep-rami, man4toman, SaeedFard, mukesh27, mohadeseghasemi, ebrahimzadeh, juiiee8487, SergeyBiryukov.
Fixes #42227 , #46806 , #46840 . See #46543 .
Built from https://develop.svn.wordpress.org/trunk@45226
git-svn-id: http://core.svn.wordpress.org/trunk@45035 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-04-17 04:13:51 +00:00
aaf99e6913
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 .
Built from https://develop.svn.wordpress.org/trunk@42343
git-svn-id: http://core.svn.wordpress.org/trunk@42172 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-11-30 23:11:00 +00:00
c90cfa3b50
General: Fix some precision alignment formatting warnings.
...
The WPCS `WordPress.WhiteSpace.PrecisionAlignment` rule throws warnings for a bunch of code that will likely cause issues for `wpcbf`. Fixing these manually beforehand gives us better auto-fixed results later.
See #41057 .
Built from https://develop.svn.wordpress.org/trunk@42228
git-svn-id: http://core.svn.wordpress.org/trunk@42057 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-11-26 23:57:55 +00:00
1a28ec87e1
Docs: Remove `@access` notations from method DocBlocks in wp-admin/* classes.
...
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.
See #41452 .
Built from https://develop.svn.wordpress.org/trunk@41161
git-svn-id: http://core.svn.wordpress.org/trunk@41001 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-07-27 00:40:43 +00:00
139387b7e5
Docs: Use 3-digit, x.x.x-style semantic versioning for `_doing_it_wrong()`, `_deprecated_function()`, `_deprecated_argument()`, and `_deprecated_file()` throughout core.
...
Props metodiew.
Fixes #36495 .
Built from https://develop.svn.wordpress.org/trunk@37985
git-svn-id: http://core.svn.wordpress.org/trunk@37926 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-07-06 12:40:29 +00:00
8c82515ab6
Update/Install: Shiny Updates v2.
...
Gone are the days of isolation and feelings of "meh", brought on by The Bleak Screen of Sadness. For a shiny knight has arrived to usher our plugins and themes along their arduous journey of installation, updates, and the inevitable fate of ultimate deletion.
Props swissspidy, adamsilverstein, mapk, afragen, ocean90, ryelle, j-falk, michael-arestad, melchoyce, DrewAPicture, AdamSoucie, ethitter, pento, dd32, kraftbj, Ipstenu, jorbin, afercia, stephdau, paulwilde, jipmoors, khag7, svovaf, jipmoors, obenland.
Fixes #22029 , #25828 , #31002 , #31529 , #31530 , #31773 , #33637 , #35032 .
Built from https://develop.svn.wordpress.org/trunk@37714
git-svn-id: http://core.svn.wordpress.org/trunk@37680 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-06-15 16:37:29 +00:00
47d26cd9fb
DOCS: Replace HTTP links with HTTPS.
...
Replaces unsecure links in documentation and translator comments with their secure versions.
Props johnpgreen, netweb
Fixes #36993
Built from https://develop.svn.wordpress.org/trunk@37674
git-svn-id: http://core.svn.wordpress.org/trunk@37640 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-06-10 04:50:33 +00:00
a4facedfee
Docs: Various docblock corrections.
...
See #32246
Built from https://develop.svn.wordpress.org/trunk@36250
git-svn-id: http://core.svn.wordpress.org/trunk@36217 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-01-10 01:26:25 +00:00
0237fadd3a
I18N: Add translator comments for strings in `wp-admin/includes/class-wp-filesystem-base.php`.
...
See #34684 .
Built from https://develop.svn.wordpress.org/trunk@35662
git-svn-id: http://core.svn.wordpress.org/trunk@35626 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-11-18 17:21:26 +00:00
b8c37073d8
Add `@access` docs to `class-wp-filesystem-*` files.
...
Props wenthemes.
Fixes #33725 .
Built from https://develop.svn.wordpress.org/trunk@33984
git-svn-id: http://core.svn.wordpress.org/trunk@33953 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-10 01:21:24 +00:00
60b8e86b36
In `WP_Filesystem_Base::chdir|chgrp|chmod()` (all mock `abstract` methods), modify `@return` to include `string` so that subclass `@return`s match.
...
See #32444 .
Built from https://develop.svn.wordpress.org/trunk@32962
git-svn-id: http://core.svn.wordpress.org/trunk@32933 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-27 00:43:24 +00:00
42fbb6568e
WP Filesystem: Correctly set the @since for WP_Filesystem_Base::getchmod() added in r32923.
...
This is 2.5.0 as that's when the function become available in all subclasses.
See #29548
Built from https://develop.svn.wordpress.org/trunk@32924
git-svn-id: http://core.svn.wordpress.org/trunk@32895 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-24 04:52:25 +00:00
8f47efe7dc
WP Filesystem: Correctly parse the permissions field in the directory listings, and actually set it in FTP environments
...
Props mnelson4 for initial patch.
Fixes #29548
Built from https://develop.svn.wordpress.org/trunk@32923
git-svn-id: http://core.svn.wordpress.org/trunk@32894 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-24 04:49:25 +00:00
c6a4512b1b
Add missing doc blocks to `wp-admin/includes/*`.
...
Fix some egregious uses of tabbing.
Some functions can simply return `apply_filters(...)` instead of setting a variable that is immediately returned.
See #32444 .
Built from https://develop.svn.wordpress.org/trunk@32654
git-svn-id: http://core.svn.wordpress.org/trunk@32624 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-29 20:17:26 +00:00
7cb45f2402
Don't call the size function `count()` as part of a test condition in loops. Compute the size beforehand, and not on each iteration.
...
Scrutinizer added a Performance label: these are the only violations.
See #30799 .
Built from https://develop.svn.wordpress.org/trunk@31554
git-svn-id: http://core.svn.wordpress.org/trunk@31535 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-02-26 05:48:24 +00:00
bc55996a0b
`@param` cleanup:
...
* `get_metadata()` will return literally anything, needs to be `mixed`
* `wp()` and `WP_Query::__construct()` no longer just take a query string
* Clarify a few others
See #30799 .
Built from https://develop.svn.wordpress.org/trunk@31212
git-svn-id: http://core.svn.wordpress.org/trunk@31193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-16 19:03:23 +00:00
b29a20b90a
`WP_Filesystem_Base` should declare `$errors` and `$options` as fields for use by subclasses.
...
See #30799 .
Built from https://develop.svn.wordpress.org/trunk@31208
git-svn-id: http://core.svn.wordpress.org/trunk@31189 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-16 17:10:43 +00:00
2749e46178
In `WP_Filesystem_Base`, make the only `private` member, `$cache`, `public` and remove magic methods. `$cache` was always `public` until [28487], has been essentially `public` via a magic method since.
...
See #30891 .
Built from https://develop.svn.wordpress.org/trunk@31145
git-svn-id: http://core.svn.wordpress.org/trunk@31126 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-11 22:04:22 +00:00
8df7115760
Use the correct hash notation syntax for the `WP_Filesystem_Base::dirlist()` DocBlock.
...
See #28298 .
Built from https://develop.svn.wordpress.org/trunk@30722
git-svn-id: http://core.svn.wordpress.org/trunk@30712 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-03 10:11:22 +00:00
c4b9da857a
Using let's properly in inline comments lets us move on to more pressing matters of inline documentation.
...
Props trepmal.
Fixes #30570 .
Built from https://develop.svn.wordpress.org/trunk@30703
git-svn-id: http://core.svn.wordpress.org/trunk@30693 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-02 04:43:22 +00:00
da4c39480f
Improve various `@param` docs for `src/wp-admin/includes/class-wp-filesystem-*.php`.
...
See #30224 .
Built from https://develop.svn.wordpress.org/trunk@30678
git-svn-id: http://core.svn.wordpress.org/trunk@30668 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-01 00:13:22 +00:00
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
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
3665b5a1a1
Add periods to short descriptions for magic methods added in [28501], [28521], and [28524].
...
See #22234 and #28885 .
Built from https://develop.svn.wordpress.org/trunk@29165
git-svn-id: http://core.svn.wordpress.org/trunk@28949 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-14 01:12:14 +00:00
e923e70d86
Fill out inline documentation for magic methods added to the `WP_Filesystem_Base` class in [28521].
...
See #22234 and #28885 .
Built from https://develop.svn.wordpress.org/trunk@29147
git-svn-id: http://core.svn.wordpress.org/trunk@28931 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-13 23:52:14 +00:00
3d0a869a21
`WP_Filesystem_Base->abspath()` should use the `WPINC` constant
...
Props wojtek.szkutnik
See #14157 .
Built from https://develop.svn.wordpress.org/trunk@28904
git-svn-id: http://core.svn.wordpress.org/trunk@28703 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-29 22:16:15 +00:00
09ecc213c8
In `WP_Filesystem_Base`, the constructor is a noop, so it shouldn't even be declared. Setting it implies that `parent::__construct()` should be called by its subclasses.
...
See #27881 , #22234 .
Built from https://develop.svn.wordpress.org/trunk@28529
git-svn-id: http://core.svn.wordpress.org/trunk@28355 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 16:46:14 +00:00
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
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
7a378bc48f
Add access modifiers to members and methods in `WP_Filesystem_Base`. Add magic `__get()` method for backwards compatibility.
...
See #27881 , #22234 .
Built from https://develop.svn.wordpress.org/trunk@28487
git-svn-id: http://core.svn.wordpress.org/trunk@28313 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 00:06:14 +00:00
Sergey Biryukov
John Blackbourn
audrasjb
Gary Pendergast
Drew Jaynes
Konstantin Obenland
Peter Wilson
Scott Taylor
Dion Hulse