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
4c3a23ba40
Docs: Fix some docblock syntax errors and add a missing canonical reference.
...
See #53399 , #52867 , #38942 , #53668
Built from https://develop.svn.wordpress.org/trunk@52034
git-svn-id: http://core.svn.wordpress.org/trunk@51626 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-11-08 10:44:59 +00:00
1d0e1397fd
Code Modernization: Fix parameter name mismatches for parent/child classes in `WP_Image_Editor::save()`.
...
Renames the first parameter in `WP_Image_Editor_GD::save()` to match the parent's method signature.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Adds @since to clearly specify why the change happened.
Adds parameter descriptions to parent and both child classes.
Follow-up to [22094], [22619], [30681].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553 .
Built from https://develop.svn.wordpress.org/trunk@51790
git-svn-id: http://core.svn.wordpress.org/trunk@51397 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 20:39:58 +00:00
da38a95d77
Media: Remove documentation detailing specific edge cases in the `image_editor_output_format` filter.
...
In [51422], a few specific edge cases were detailed so that developers using the hook were aware of known pitfalls.
These edge cases have been fixed in 5.8.1 through [51653] and [51704], so the documentation is no longer necessary.
Props azaozz, audrasjb.
Fixes #53955 .
Built from https://develop.svn.wordpress.org/trunk@51717
git-svn-id: http://core.svn.wordpress.org/trunk@51323 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-01 17:17:58 +00:00
f405add8f0
Media: apply the `wp_editor_set_quality` filter not only when loading an image in the editor but also when saving an converted image, after the mime-type of the output image has changed.
...
Props mikeschroder, desrosj, azaozz.
Fixes #53667 .
Built from https://develop.svn.wordpress.org/trunk@51704
git-svn-id: http://core.svn.wordpress.org/trunk@51310 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-08-31 18:59:03 +00:00
94a990de99
Media: Fix `wp_unique_filename()` to check for name collisions with all alternate file names when an image may be converted after uploading. This includes possible collinions with pre-existing images whose sub-sizes/thumbnails are regenerated.
...
Props ianmjones, azaozz.
Fixes #53668 .
Built from https://develop.svn.wordpress.org/trunk@51653
git-svn-id: http://core.svn.wordpress.org/trunk@51259 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-08-24 20:52:03 +00:00
904862da90
Media: Document edge cases with the new `image_editor_output_format` filter.
...
More testing has revealed that the `image_editor_output_format` filter has some interesting edge cases that developers should be aware of when electing to use this filter (see #53667 and #53668 ).
Because this is a new filter that was intended to be used for experimenting with different ways to handle generating image sizes and has not yet been adopted in the wild, expanding the inline documentation is an acceptable temporary solution while these edge cases are explored further and addressed.
Props mikeschroder, antpb, desrosj, adamsilverstein, ianmjones.
See #5366 , #53668 , #35725 .
Built from https://develop.svn.wordpress.org/trunk@51442
git-svn-id: http://core.svn.wordpress.org/trunk@51053 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-15 17:39:59 +00:00
79685db062
Docs: Corrections and improvements to types used in docblocks for symbols, properties, and filters.
...
See #53399
Built from https://develop.svn.wordpress.org/trunk@51298
git-svn-id: http://core.svn.wordpress.org/trunk@50907 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-01 21:02:57 +00:00
fccc020d29
Docs: Various docblock corrections for code added in 5.8.
...
Props johnbillion.
See #53461 .
Built from https://develop.svn.wordpress.org/trunk@51221
git-svn-id: http://core.svn.wordpress.org/trunk@50830 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-06-23 19:05:57 +00:00
5ffa346fd0
Media: Some documentation and test improvements for the `image_editor_output_format` filter:
...
* Update the filter DocBlock per the documentation standards.
* Use a shorter variable name for consistency with the surrounding code.
* Delete the test file before performing assertions to avoid leftovers in case the test fails.
Follow-up to [50943].
See #52867 .
Built from https://develop.svn.wordpress.org/trunk@50951
git-svn-id: http://core.svn.wordpress.org/trunk@50560 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-05-22 13:00:02 +00:00
8284a1f6ae
Media: Introduces `image_editor_output_format` filter for setting default MIME type of sub size image output.
...
This change introduces the `image_editor_output_format` filter, which fires as sub size images are generated allowing to define a default image MIME type for those items.
Props adamsilverstein, williampatton, spacedmonkey, mikeschroder, hellofromTonya, justinahinon, Boniu91, antpb, SergeyBiryukov.
Fixes #52867 .
Built from https://develop.svn.wordpress.org/trunk@50943
git-svn-id: http://core.svn.wordpress.org/trunk@50552 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-05-20 22:15:56 +00:00
dfe1f9b322
Docs: Promote many `bool` types to `true` or `false` where only that value is used.
...
See #51800
Built from https://develop.svn.wordpress.org/trunk@49927
git-svn-id: http://core.svn.wordpress.org/trunk@49626 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-01-03 22:04:04 +00:00
a8d8f22f4e
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
...
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663 .
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 14:37:05 +00:00
57a3f803ae
Docs: First pass at some inline docs fixes mostly made by PHPCBF.
...
See #49572 , #50744
Built from https://develop.svn.wordpress.org/trunk@48586
git-svn-id: http://core.svn.wordpress.org/trunk@48348 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-23 20:01:04 +00:00
0bf9b04c53
Docs: Various formatting improvements to inline docblocks.
...
See #49572
Built from https://develop.svn.wordpress.org/trunk@48574
git-svn-id: http://core.svn.wordpress.org/trunk@48336 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-23 00:52:05 +00:00
be16bb9fba
Docs: Remove extra spaces from `@param` tags.
...
Per the documentation standards, `@param` tags should be aligned with each other, but not with the `@return` tag.
See #49572 .
Built from https://develop.svn.wordpress.org/trunk@48110
git-svn-id: http://core.svn.wordpress.org/trunk@47879 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-20 12:58:10 +00:00
1a77bb81d8
Docs: Remove unnecessary variables names from `@return` tags.
...
See #49572 .
Built from https://develop.svn.wordpress.org/trunk@48100
git-svn-id: http://core.svn.wordpress.org/trunk@47869 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-19 22:55: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
38676936ba
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 .
Built from https://develop.svn.wordpress.org/trunk@47550
git-svn-id: http://core.svn.wordpress.org/trunk@47325 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-04-05 03:02:11 +00:00
641c632b0c
Coding Standards: Use Yoda conditions where appropriate.
...
See #49222 .
Built from https://develop.svn.wordpress.org/trunk@47219
git-svn-id: http://core.svn.wordpress.org/trunk@47019 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-02-09 16:55:09 +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
dd4d98a368
Docs: In various `@return` tags, list the expected type first, instead of `false`.
...
Follow-up to [46696].
See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47060
git-svn-id: http://core.svn.wordpress.org/trunk@46860 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-01-11 18:32:05 +00:00
418db0297e
Docs: Correct spelling of "subclass" and "overridden" in various docblocks and error messages.
...
Props garrett-eclipse.
Fixes #48676 .
Built from https://develop.svn.wordpress.org/trunk@46739
git-svn-id: http://core.svn.wordpress.org/trunk@46539 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-17 07:43:01 +00:00
9ac1d82f23
Docs: Further improve documentation of known return types, plus other docs fixes.
...
See #48303
Built from https://develop.svn.wordpress.org/trunk@46661
git-svn-id: http://core.svn.wordpress.org/trunk@46461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-05 21:27:02 +00:00
29ea4c6a4c
Media/Upload: rotate images on upload according to EXIF Orientation.
...
Props msaggiorato, wpdavis, markoheijnen, dhuyvetter, msaggiorato, n7studios, triplejumper12, pbiron, mikeschroder, joemcgill, azaozz.
Fixes #14459 .
Built from https://develop.svn.wordpress.org/trunk@46202
git-svn-id: http://core.svn.wordpress.org/trunk@46014 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-20 18:21:57 +00:00
4803fc405e
Coding Standards: Fix the `Squiz.PHP.DisallowMultipleAssignments` violations in `wp-includes`.
...
See #47632 .
Built from https://develop.svn.wordpress.org/trunk@45590
git-svn-id: http://core.svn.wordpress.org/trunk@45401 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-02 23:42:58 +00:00
08227812a0
Docs: Remove `@static` notations from method DocBlocks in `wp-includes/*` classes.
...
This tag has been used in the past, but should no longer be used. Just using the `static` keyword in code is enough for PhpDocumentor on PHP5+ to recognize static variables and methods, and PhpDocumentor will mark them as static.
Props birgire.
See #42803 .
Built from https://develop.svn.wordpress.org/trunk@42746
git-svn-id: http://core.svn.wordpress.org/trunk@42576 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-02-25 20:22:30 +00:00
abf27d78b9
Media: After [42695], remove redundant check that is already performed a few lines above.
...
Props gnif.
See #43255 .
Built from https://develop.svn.wordpress.org/trunk@42702
git-svn-id: http://core.svn.wordpress.org/trunk@42530 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-02-11 21:55:30 +00:00
e6322d0afe
Media: In `WP_Image_Editor::make_image()`, close previously opened output buffer if the file could not be created.
...
Props dhanendran, gnif.
Fixes #43255 .
Built from https://develop.svn.wordpress.org/trunk@42695
git-svn-id: http://core.svn.wordpress.org/trunk@42523 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-02-11 16:25:31 +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
9891448a42
Media: Rename several attachment related parameters from `$post_id` to `$attachment_id` for clarity, and improve related
...
documentation.
See #41017
Built from https://develop.svn.wordpress.org/trunk@41288
git-svn-id: http://core.svn.wordpress.org/trunk@41128 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-08-22 11:12:44 +00:00
0860bb2771
Docs: Remove `@access` notations from method DocBlocks in wp-includes/* 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@41162
git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-07-27 00:41:44 +00:00
8c55e79bef
Docs: Correct `@access` entry for `::load()` in `WP_Image_Editor`, `WP_Image_Editor_GD`, and `WP_Image_Editor_Imagick`.
...
Props upadalavipul.
Fixes #41423 .
Built from https://develop.svn.wordpress.org/trunk@41125
git-svn-id: http://core.svn.wordpress.org/trunk@40965 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-07-24 14:11:44 +00:00
7ac88c02fa
Media: when calling `pathinfo()`, also pass a `PATHINFO_*` constant to avoid array notices for unset keys.
...
Props JaworskiMatt.
Fixes #37608 .
Built from https://develop.svn.wordpress.org/trunk@38294
git-svn-id: http://core.svn.wordpress.org/trunk@38235 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-08-20 23:36:28 +00:00
602b51a209
Docs: Standardize filter docs in core classes in wp-includes/* to use third-person singular verbs per the inline documentation standards for PHP.
...
See #36913 .
Built from https://develop.svn.wordpress.org/trunk@37492
git-svn-id: http://core.svn.wordpress.org/trunk@37460 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-22 18:15:28 +00:00
b1804afeaf
Docs: Standardize on 'backward compatibility/compatible' nomenclature in core inline docs.
...
Also use 'back-compat' in some inline comments where backward compatibility is the subject and shorthand feels more natural.
Note: 'backwards compatibility/compatibile' can also be considered correct, though it's primary seen in regular use in British English.
Props ocean90.
Fixes #36835 .
Built from https://develop.svn.wordpress.org/trunk@37431
git-svn-id: http://core.svn.wordpress.org/trunk@37397 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-13 18:41:31 +00:00
55cc876141
Media: Reduce default image compression quality to '82'.
...
Changes default image compression quality from '90' to '82'.
This reduces generated image file sizes by ~25% while
keeping DSSIM < 0.0023, with both Imagick and GD.
Props @joemcgill, @dnewton.
See #33642 .
Built from https://develop.svn.wordpress.org/trunk@36615
git-svn-id: http://core.svn.wordpress.org/trunk@36582 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-22 22:19:26 +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
ef87172270
`foreach` is a statement, not a function.
...
See #33491 .
Built from https://develop.svn.wordpress.org/trunk@33734
git-svn-id: http://core.svn.wordpress.org/trunk@33702 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-25 20:28:22 +00:00
a0e373ef80
For doc block types, favor `bool` over the few remaining `boolean`s
...
See #32444 .
Built from https://develop.svn.wordpress.org/trunk@32964
git-svn-id: http://core.svn.wordpress.org/trunk@32935 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-27 01:03:25 +00:00
5c6b63d3a6
`if` is a statment, not a function.
...
See #32444 .
Built from https://develop.svn.wordpress.org/trunk@32800
git-svn-id: http://core.svn.wordpress.org/trunk@32771 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-16 20:01:25 +00:00
19a3aacc94
Add `@static*` annotations where they are missing.
...
Initialize all static vars that are not, most to `null`.
See #32444 .
Built from https://develop.svn.wordpress.org/trunk@32650
git-svn-id: http://core.svn.wordpress.org/trunk@32620 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-29 15:43:29 +00:00
bf43be3e9e
Add missing doc blocks to `wp-image-editor*.php`.
...
See #32444 .
Built from https://develop.svn.wordpress.org/trunk@32546
git-svn-id: http://core.svn.wordpress.org/trunk@32516 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-22 06:18:25 +00:00
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
42f5acd869
Improve some docs for `@param`. Remove an unneeded `$wpdb` global import.
...
See #30799 .
Built from https://develop.svn.wordpress.org/trunk@30979
git-svn-id: http://core.svn.wordpress.org/trunk@30965 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-20 20:56:22 +00:00
618b673470
Clarify the behaviour of the `wp_editor_set_quality` and `jpeg_quality` filters.
...
Props DH-Shredder
See #29856
Built from https://develop.svn.wordpress.org/trunk@30874
git-svn-id: http://core.svn.wordpress.org/trunk@30863 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-15 21:43:22 +00:00
b2185048c6
Move the logic from WP_Image_Editor::get_quality() to WP_Image_Editor::set_quality(), so that 'wp_editor_set_quality' and 'jpeg_quality' filters run when setting the default value.
...
props markoheijnen.
fixes #29856 .
Built from https://develop.svn.wordpress.org/trunk@30788
git-svn-id: http://core.svn.wordpress.org/trunk@30778 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-08 16:19:23 +00:00
221db8fd8d
Fix setting default quality in WP_Image_Editor.
...
props markoheijnen.
fixes #29856 for trunk.
Built from https://develop.svn.wordpress.org/trunk@29834
git-svn-id: http://core.svn.wordpress.org/trunk@29598 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-04 13:12:15 +00:00
cf95c6ecc2
Add `->get_quality()` method to `WP_Image_Editor` class.
...
Adds unit tests.
Props markoheijnen.
Fixes #28154 .
Built from https://develop.svn.wordpress.org/trunk@28879
git-svn-id: http://core.svn.wordpress.org/trunk@28678 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-28 03:50:15 +00:00
013d4dc387
In `WP_Image_Editor::get_output_format()`, `$file_mime` and `$file_ext` are set twice before they are used.
...
See #27882 .
Built from https://develop.svn.wordpress.org/trunk@28320
git-svn-id: http://core.svn.wordpress.org/trunk@28148 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-06 18:37:29 +00:00
John Blackbourn
hellofromTonya
desrosj
Andrew Ozz
Sergey Biryukov
antpb
Mike Schroder
Gary Pendergast
Drew Jaynes
Scott Taylor