Commit Graph

74 Commits

Author SHA1 Message Date
Sergey Biryukov
f6973306ea Docs: Improve documentation for a few functions accepting a WP_Post object.
Follow-up to [15777], [23769], [24490], [25697], [37252], [49544].

See #60699.
Built from https://develop.svn.wordpress.org/trunk@58212


git-svn-id: http://core.svn.wordpress.org/trunk@57675 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-27 16:29:16 +00:00
Sergey Biryukov
77dfc892fe Docs: Document default values for optional parameters in various DocBlocks.
Props paulkevan, costdev, audrasjb, SergeyBiryukov.
See #56792.
Built from https://develop.svn.wordpress.org/trunk@55398


git-svn-id: http://core.svn.wordpress.org/trunk@54931 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-21 16:39:19 +00:00
John Blackbourn
f4cda1b62f Docs: Upgrade more parameters in docblocks to used typed array notation.
See #51800, #41756

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


git-svn-id: http://core.svn.wordpress.org/trunk@49416 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-24 21:27:05 +00:00
John Blackbourn
34765ddb64 Docs: Docblock corrections relating to WP_Post objects.
See #51373, #50768

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


git-svn-id: http://core.svn.wordpress.org/trunk@49282 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-09 15:15:08 +00:00
John Blackbourn
c16ae60deb Docs: Fix and upgrade various object docblock notations.
See #50768

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


git-svn-id: http://core.svn.wordpress.org/trunk@48945 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-17 16:05:09 +00:00
Sergey Biryukov
58ad216087 Docs: Improve documentation for optional parameters per the documentation standards.
See #49572.
Built from https://develop.svn.wordpress.org/trunk@48197


git-svn-id: http://core.svn.wordpress.org/trunk@47966 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-28 11:49:02 +00:00
Sergey Biryukov
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
Sergey Biryukov
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
Sergey Biryukov
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
John Blackbourn
f93ee2ca76 Docs: Increase the specificity of various docblock parameter types and return types.
See #48303
Built from https://develop.svn.wordpress.org/trunk@46823


git-svn-id: http://core.svn.wordpress.org/trunk@46623 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-12-06 22:43:04 +00:00
John Blackbourn
f545bb3f63 Docs: Improve documentation of known return types, plus other docs fixes.
See #48303

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


git-svn-id: http://core.svn.wordpress.org/trunk@46460 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-05 21:23:02 +00:00
Sergey Biryukov
b1e34ccc1f Docs: Add missing description for $wp_rewrite global.
See #45604, #47110.
Built from https://develop.svn.wordpress.org/trunk@45735


git-svn-id: http://core.svn.wordpress.org/trunk@45546 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-08-04 01:19:56 +00:00
Sergey Biryukov
810b1333ff Post Formats: Don't assign a variable inside if statement in get_post_format().
Props Mirucon.
Fixes #44840.
Built from https://develop.svn.wordpress.org/trunk@43592


git-svn-id: http://core.svn.wordpress.org/trunk@43421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-30 09:01:25 +00:00
Gary Pendergast
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
Drew Jaynes
f94c77661d Docs: Improve the return description for get_post_format_slugs() to note that the array contains slugs as both keys and values.
Props danielbachhuber.
Fixes #38611.

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


git-svn-id: http://core.svn.wordpress.org/trunk@41124 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-08-20 20:03:54 +00:00
Scott Taylor
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
Scott Taylor
4c6d8467e2 Add missing doc blocks to post-formats.php.
Correct some types for `@param` and `@return`.

See #32444.

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


git-svn-id: http://core.svn.wordpress.org/trunk@32586 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-27 16:06:25 +00:00
Dominik Schilling
60c9fdf9fd Merge similar error strings for invalid data.
props pavelevap.
fixes #32329.
Built from https://develop.svn.wordpress.org/trunk@32477


git-svn-id: http://core.svn.wordpress.org/trunk@32447 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-09 21:09:25 +00:00
Scott Taylor
bce851dcf2 Replace array_shift() with reset() where appropriate for performance.
Props SergeyBiryukov.
Fixes #31259.

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


git-svn-id: http://core.svn.wordpress.org/trunk@31811 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-03-19 03:56:27 +00:00
Scott Taylor
fc843ce4d0 There are some random add_action() and add_filter() calls littered around some files in wp-includes/. These should be moved to wp-includes/default-filters.php with the rest of the registered hooks. It seems like this was the best practice for awhile and then we randomly stopped. This file loads way before any of the includes, so the hooks will be registered for any request that loads WordPress, even SHORTINIT - a lot of the hooks registered won't run anyways (that's already the case).
See #30947.

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


git-svn-id: http://core.svn.wordpress.org/trunk@31149 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-12 16:40:23 +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
Jon Cave
37377f57aa Allow has_post_format() to be used to check for any format.
Calling has_post_format() with an empty list of $format will check if the
provided post has any associated format at all.

Props obenland, DrewAPicture, nacin. Fixes #24906.

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


git-svn-id: http://core.svn.wordpress.org/trunk@26251 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-24 13:45:10 +00:00
Andrew Nacin
02b214cd85 Allow has_post_format() to accept an array of formats to check. props ericmann. fixes #17320.
git-svn-id: http://core.svn.wordpress.org/trunk@24817 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-07-28 20:48:09 +00:00
Andrew Nacin
098ea1a759 Revert title auto-generation for asides and statuses.
Reverts [24043] and related.

fixes #24011.



git-svn-id: http://core.svn.wordpress.org/trunk@24693 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-07-12 22:35:38 +00:00
Andrew Nacin
7690d7fbeb Move get_url_in_content() out of post-formats.php. see #24202.
git-svn-id: http://core.svn.wordpress.org/trunk@24683 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-07-12 19:38:37 +00:00
Andrew Nacin
4a1e326c1f Simplify and reduce the new media/content extraction functions.
The URL extraction function is now get_url_in_content(). For more, see #24202.

Also adds filters to get_post_galleries() and get_post_gallery(). fixes #24309.



git-svn-id: http://core.svn.wordpress.org/trunk@24682 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-07-12 19:34:59 +00:00
Dominik Schilling
6ba7413fbd Lose content removal and splitting from get_content_url(). And remove unneeded lines from [24400].
fixes #24484.

git-svn-id: http://core.svn.wordpress.org/trunk@24554 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-07-03 22:36:13 +00:00
Mark Jaquith
fe5b462eea Remove a bunch of Post Format template functions.
* get_post_format_meta()
* add_chat_detection_format()
* get_content_chat()
* get_the_post_format_chat()
* the_post_format_chat()
* get_content_quote()
* get_the_post_format_quote()
* the_post_format_quote()
* get_the_post_format_url()
* the_post_format_url()
* get_the_remaining_content()
* the_remaining_content()

see #24452

git-svn-id: http://core.svn.wordpress.org/trunk@24399 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-06-02 16:26:10 +00:00
Mark Jaquith
c5530f9fc6 Revert [23450]. Removes post format compat.
see #23347, #24452. closes #24454.

git-svn-id: http://core.svn.wordpress.org/trunk@24387 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-30 17:55:22 +00:00
Sergey Biryukov
063b1d4cb8 Use correct variable. props tollmanz. fixes #24419.
git-svn-id: http://core.svn.wordpress.org/trunk@24353 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-25 11:35:43 +00:00
Ryan Boren
a2b4bc456f * Introduce wp_parse_post_content() and use it in setup_postdata(), get_the_content(), and get_the_remaining_content().
* Add a post ID argument to the_content(), get_the_content(), the_remaining_content(), and get_the_remaining_content().
* Pass the post ID to the the_content filter.
* Remove the format_pages global.
* Declare format_content and split_content as vars in WP_Post.
* phpdoc for the the_content filter that documents the new ID argument and denotes it as not-so-portable.

Props gcorne, DrewAPicture, duck_, aaroncampbell
see #24330


git-svn-id: http://core.svn.wordpress.org/trunk@24301 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-20 11:05:50 +00:00
Ryan Boren
f14b0c3e13 Remove redundant post ID validation.
Props SergeyBiryukov
fixes #24199


git-svn-id: http://core.svn.wordpress.org/trunk@24249 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-14 13:57:59 +00:00
Mark Jaquith
0a67245cfd Revert change to get_post_format() introduced in [24226].
see #24291

git-svn-id: http://core.svn.wordpress.org/trunk@24242 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-10 23:22:51 +00:00
Mark Jaquith
74c6071b9d Improve regular expressions by using a backreference to match right quote of quote pair when matching attributes.
props kovshenin. see #24225.

git-svn-id: http://core.svn.wordpress.org/trunk@24241 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-10 22:54:33 +00:00
Sergey Biryukov
4f2a58e3df Update _post_formats_fix_empty_title() description. Make it clear that 'wp_insert_post_data' is a filter, not an action. props DrewAPicture. fixes #24303.
git-svn-id: http://core.svn.wordpress.org/trunk@24233 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-10 14:53:34 +00:00
Mark Jaquith
f63001eb2c Improve the UX and flow of the Image post format.
* Drag-and-drop
* Textarea for HTML/URL hidden to start
* Bigger click target for entering Media modal
* Image preview height-contrained to 300 pixels
* Hid the alignment, size, etc options that didn't have an effect anyway
* Got wp-format-{format} into the <body> class

props DrewAPicture, aaroncampbell, markjaquith, azaozz. see #24291.

git-svn-id: http://core.svn.wordpress.org/trunk@24226 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-09 22:45:14 +00:00
Sergey Biryukov
57c10eadbb Use ellipsis instead of three dots. props tjsingleton, jordie23, wojtek.szkutnik, DrewAPicture, SergeyBiryukov. see #8714.
git-svn-id: http://core.svn.wordpress.org/trunk@24207 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-08 21:27:31 +00:00
Mark Jaquith
22c80c1a99 Add a 'quote_source_format' filter and make the default an em-dash and a space preceding the source.
fixes #24243

git-svn-id: http://core.svn.wordpress.org/trunk@24170 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-03 19:08:47 +00:00
Sergey Biryukov
4705c96648 Make $post_id argument optional for _post_formats_title(). props kovshenin. fixes #24233. see #24011.
git-svn-id: http://core.svn.wordpress.org/trunk@24146 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-30 23:48:18 +00:00
Andrew Nacin
3139a0451e Variables passed by reference do not need to be set first.
props kovshenin.
see #24222.



git-svn-id: http://core.svn.wordpress.org/trunk@24129 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-29 14:48:31 +00:00
Mark Jaquith
644e5b7bd6 Prevent a PHP Warning for $post_format.
props MZAWeb, kovshenin. see #24011.

git-svn-id: http://core.svn.wordpress.org/trunk@24094 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-25 08:02:38 +00:00
Mark Jaquith
759b3f5e82 Fix redundant use of array_keys() around get_post_format_slugs().
props SergeyBirkukov, wonderboymusic. fixes #24089.

git-svn-id: http://core.svn.wordpress.org/trunk@24082 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-25 03:06:31 +00:00
Mark Jaquith
c546e83a58 Add a post_format_meta filter.
props alexkingorg. fixes #24162.

git-svn-id: http://core.svn.wordpress.org/trunk@24080 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-25 02:31:42 +00:00
Mark Jaquith
cd0bbd830c Fix mangled image output in compat function.
props wonderboymusic. see #24175.

git-svn-id: http://core.svn.wordpress.org/trunk@24078 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-25 02:18:49 +00:00
Helen Hou-Sandí
e5cf5ca63d Respect $compat values for the link format fallback output. props wonderboymusic. see #23347.
git-svn-id: http://core.svn.wordpress.org/trunk@24075 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-23 23:19:29 +00:00
Mark Jaquith
8ec637b13d Fix some mangled HTML in image format posts compat.
props SergeyBiryukov. fixes #24147.

git-svn-id: http://core.svn.wordpress.org/trunk@24062 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-22 21:01:03 +00:00
Andrew Nacin
84c41080f5 Return false in get_post_format() if the post does not exist.
props adamsilverstein, ericlewis.
fixes #23255.



git-svn-id: http://core.svn.wordpress.org/trunk@24057 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-22 20:41:16 +00:00
Sergey Biryukov
b8805d7f22 Correct phpdoc for get_content_quote(). props kovshenin. see #24009.
git-svn-id: http://core.svn.wordpress.org/trunk@24045 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-22 14:36:43 +00:00
Mark Jaquith
18aab9531a Hide the post title and auto-generate based on the post body, for the status and aside post formats.
props kovshenin. see #24011.

git-svn-id: http://core.svn.wordpress.org/trunk@24043 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-22 04:00:25 +00:00
Mark Jaquith
2d382c1a5c Post Formats: use the content body for the body of the Quote post format.
* Searchable, better editing tools
* Less cluttered Post Format UI

props kovshenin, DrewAPicture. see #24009

git-svn-id: http://core.svn.wordpress.org/trunk@24034 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-18 18:07:58 +00:00