Commit Graph

228 Commits

Author SHA1 Message Date
Drew Jaynes 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
Drew Jaynes 9e4415bc5f Docs: Ignore `_wp_upload_dir_baseurl()` from parsing for the Code Reference.
See #36371.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37081 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-30 15:29:26 +00:00
Andrew Ozz bfd19e92f5 Add deprecated notice and removal warning to `_wp_upload_dir_baseurl()`.
Props DrewAPicture, azaozz.
Fixes #36371.
Built from https://develop.svn.wordpress.org/trunk@37112


git-svn-id: http://core.svn.wordpress.org/trunk@37079 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-30 15:10:27 +00:00
Drew Jaynes bd3a1d74d9 Docs: Improve a variety of DocBlocks in wp-includes/deprecated.php.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36730 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 19:32:25 +00:00
Drew Jaynes f976c0a6c8 Docs: Add missing parameter and return descriptions to the DocBlock for the deprecated `default_topic_count_text()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36727 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 18:36:27 +00:00
Drew Jaynes b09aa14358 Docs: Add missing parameter and return documentation to the DocBlock for the deprecated `_search_terms_tidy()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36726 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 18:35:26 +00:00
Drew Jaynes 49c0c2b7aa Docs: Add missing documentation for the `&$post` parameter in the DocBlock for the deprecated `_get_post_ancestors()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36725 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 18:33:25 +00:00
Drew Jaynes e92ed036cc Docs: Add missing documentation for the `$fp` parameter to the DocBlock for the deprecated `debug_fclose()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36724 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 18:31:26 +00:00
Drew Jaynes 85efc3675a Docs: Add missing parameter documentation to the DocBlock for the deprecated `debug_fwrite()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36723 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 18:30:27 +00:00
Drew Jaynes b878338b1d Docs: Add missing parameter and return documentation to the DocBlock for the deprecated `debug_fopen()`.
Fixes #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36722 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 18:20:26 +00:00
Drew Jaynes d48cd1cb28 Docs: Add missing documentation for the `$wp_admin_bar` parameter in the DocBlock for the deprecated `wp_admin_bar_dashboard_view_site_menu()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36721 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 18:18:28 +00:00
Drew Jaynes 268d09070e Docs: Add missing documentation for the `$title` parameter in the DocBlock for the deprecated `parent_post_rel_link()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36720 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-28 18:16:26 +00:00
Drew Jaynes b64819d3a0 Docs: Remove a duplicate parameter notation in the DocBlock for the deprecated `the_editor()` function.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36715 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-27 21:41:26 +00:00
Andrew Ozz 2d94e025a2 Replace `wp_upload_dir()` with the new `wp_get_upload_dir()` in all cases where a file is not being uploaded. Deprecate `_wp_upload_dir_baseurl()`, and replace it with `wp_get_upload_dir()`.
See #34359.
Built from https://develop.svn.wordpress.org/trunk@36569


git-svn-id: http://core.svn.wordpress.org/trunk@36536 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-18 00:24:27 +00:00
Eric Lewis 22467e840f Networks and sites: Replace "blog" usage with "site" in docs.
Multisite functions use the term "blog" to refer to what we now call a "site," e.g. `get_current_blog_id()`. These functions are here to stay because of our commitment to backwards compatibility. What we can do is set the documentation straight.

See #35417.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36383 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-01-28 03:35:27 +00:00
John Blackbourn d84621cc19 Docs: Correct a funky docblock in `funky_javascript_fix()`.
See #32246

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


git-svn-id: http://core.svn.wordpress.org/trunk@36076 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-28 17:18:30 +00:00
John Blackbourn 0003a004db Docs: Miscellaneous docblock code quality tweaks.
See #32246

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


git-svn-id: http://core.svn.wordpress.org/trunk@36039 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-23 07:53:26 +00:00
Drew Jaynes a28bfe8ba6 Docs: Add missing notations for the optional `$tab_index` and `$extended` parameters in the DocBlock for the deprecated `the_editor()` function.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35998 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-20 21:21:27 +00:00
Drew Jaynes 5399b2137f Docs: Add missing parameter and return notations to the DocBlock for the deprecated `get_usernumposts()` function.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35995 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-19 19:41:30 +00:00
Drew Jaynes 013d1178e5 Docs: Add missing parameter and return notations in the DocBlock for `get_profile()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35993 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-19 09:04:26 +00:00
Drew Jaynes 543420158f Docs: Properly mark the `$classname` parameter as optional.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-19 09:00:26 +00:00
Drew Jaynes eb158d65c7 Docs: Add missing parameter and return notations to the DocBlock for the deprecated `wp_specialchars()` function.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35991 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-19 08:58:25 +00:00
Drew Jaynes 57878dd1b9 Docs: Add missing parameter notations and descriptions in the DocBlock for `get_link()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35990 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-19 08:54:26 +00:00
Drew Jaynes 932c91b766 Docs: Add missing parameter and return notations in the DocBlock for the deprecated `_nc()` function.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35989 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-19 08:48:27 +00:00
Drew Jaynes 7b1ac33dee Docs: Add a missing summary, parameter, and return descriptiosn to the DocBlock for the deprecated function, `get_linkrating()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35988 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-19 08:23:26 +00:00
Pascal Birchler 54b8c3e53b Docs: Fix some minor DocBlock alignment issues.
See #32246.
Built from https://develop.svn.wordpress.org/trunk@35885


git-svn-id: http://core.svn.wordpress.org/trunk@35849 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-12 15:37:28 +00:00
John Blackbourn a027edc277 Comments: The year is 2003. Permalinks are a new thing and everyone's using Blogger. It's a time when opening a modal window in JavaScript to view a section of a website is not a completely weird thing, although many users get annoyed by it. b2 has recently become WordPress, and with it comes a bunch of functionality that will become stale over the next decade, remnants of simpler times.
Twelve years later, after no fewer than three themes have intentionally implemented popup comments in their functionality, before being abandoned for at least the last six years, we've reached a time where we can put this era behind us. A time when we can remove comment popup functionality from WordPress.

If this breaks the internet, I'll eat my hat.

Fixes #28617

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


git-svn-id: http://core.svn.wordpress.org/trunk@35812 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-10 03:06:30 +00:00
Konstantin Obenland e1901c38c1 Template: Un-deprecate `wp_title()`.
Before it can be deprecated we should identify alternative usages and define
a path forward for them.

See [35294], #31078.


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


git-svn-id: http://core.svn.wordpress.org/trunk@35588 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-11-11 23:50:25 +00:00
Drew Jaynes 81524f3bfc Filesystem: Following the introduction of the `KB|MB|GB|TB_IN_BYTES` constants in [35286], use them in various places in core.
Props sudar.
Fixes #22405.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35291 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-21 14:03:25 +00:00
Drew Jaynes 08f3a3b226 Docs: Fix up DocBlock syntax for the now-deprecated `wp_title()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35262 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-20 17:53:24 +00:00
Konstantin Obenland c69e96422b Themes: Improve document title output.
Introduces more flexibility in filtering all parts of the document title,the
separator, and a way to short-circuit title generation. Plugins can now also
check for theme support and reliably filter the entire output. See #18548.
Deprecates `wp_title()`.

Fixes #31078.


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


git-svn-id: http://core.svn.wordpress.org/trunk@35260 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-20 16:21:25 +00:00
Drew Jaynes 471a507dfd Docs: Add an `@see` reference for the "use-instead-of" function in the DocBlock for `force_ssl_login()`, deprecated in [34700].
See #34011. See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@34670 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-29 22:46:25 +00:00
John Blackbourn a8728b987f Deprecate `force_ssl_login()`, which is simply a wrapper for `force_ssl_admin()` and is not used in core.
Fixes #34011

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


git-svn-id: http://core.svn.wordpress.org/trunk@34664 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-29 21:28:50 +00:00
John Blackbourn aa35e473f7 `callback` is not a valid type in PHP, PSR-5, or phpDocumentor. `callable` should be used instead.
Fixes #34032

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


git-svn-id: http://core.svn.wordpress.org/trunk@34530 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-25 23:58:25 +00:00
Scott Taylor 62ec4a3bfd Deprecate `wp_get_http()` - function isn't used anywhere (apart from itself).
Props swissspidy.
Fixes #33709.

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


git-svn-id: http://core.svn.wordpress.org/trunk@33938 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-09 04:26:25 +00:00
Drew Jaynes e9f1e69b23 Docs: Standardize `@deprecated` tag formatting and add missing DocBlock summaries to deprecated functions in wp-includes/deprecated.php.
Props Alphawolf for the initial patch.
Props DrewAPicture.

See #28806.

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


git-svn-id: http://core.svn.wordpress.org/trunk@33640 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-20 22:11:26 +00:00
Scott Taylor 45fc6a3def Deprecate `post_permalink()` (Introduced in 1.0, already had a deprecated argument in 1.3), which just wraps `get_permalink()` and was only used by XML-RPC in 4 places.
Props solarissmoke.
Fixes #16982.

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


git-svn-id: http://core.svn.wordpress.org/trunk@33626 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-20 06:24:26 +00:00
Dominik Schilling 8679a93f16 Themes: Remove legacy theme preview.
The pre-3.4 theme previewer doesn't work when using a static front page.
We kept the old theme preview for no-JS and some browsers that were less capable. But since browsers are doing a better job today we don't need to continue fixing/shipping this legacy code. Bye!

fixes #33178.
Built from https://develop.svn.wordpress.org/trunk@33492


git-svn-id: http://core.svn.wordpress.org/trunk@33459 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-07-29 18:36:26 +00:00
Scott Taylor 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
Andrew Ozz e4758f42e5 Update the TinyMCE initialization:
- Replace `wp_htmledit_pre()` and `wp_richedit_pre()` with `format_for_editor()`.
- Replace the `'htmledit_pre'` and `'richedit_pre'` filters with `'format_for_editor'`.
- Do not run the post content through `wpautop()` in PHP when the visual editor is default. Run the textarea content through the JS wpautop on initializing TinyMCE.
- Simplify both editors initialization.
- Improve setting of `wpActiveEditor` in Quicktags.
- Improve editor.js, use `tinymce.$` when possible.
See #32425.
Built from https://develop.svn.wordpress.org/trunk@32899


git-svn-id: http://core.svn.wordpress.org/trunk@32870 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-21 22:01:28 +00:00
Dominik Schilling 64fc7294b6 Use HTTPS URLs for codex.wordpress.org.
see #27115.
Built from https://develop.svn.wordpress.org/trunk@32116


git-svn-id: http://core.svn.wordpress.org/trunk@32095 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-04-12 21:29:32 +00:00
Scott Taylor dccf5ceb90 Empty `return` statements are unnecessary at the end of functions.
See #30799.

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


git-svn-id: http://core.svn.wordpress.org/trunk@31660 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-03-08 23:09:27 +00:00
Scott Taylor 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
Scott Taylor 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
Scott Taylor fe6b5983df 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.

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


git-svn-id: http://core.svn.wordpress.org/trunk@31169 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-16 01:06:24 +00:00
Scott Taylor 8ee598169f After [31105], don't ditch the `isset()` calls for BC. Declare `$page_hook` as `null` so it is initialized for all execution paths but will still fail `isset()` checks.
Fixes #30958.

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


git-svn-id: http://core.svn.wordpress.org/trunk@31087 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-08 22:52:22 +00:00
Scott Taylor 60e1dd409b Properly declare `$hook_suffix`, `$plugin_page`, `$typenow`, and `$taxnow` as globals in `wp-admin/admin.php`.
Fixes #30958.

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


git-svn-id: http://core.svn.wordpress.org/trunk@31086 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-08 22:15:24 +00:00
Scott Taylor 60b0cd7943 The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words.
This was a mess, is now standardized across the codebase, except for a few 3rd-party libs. 

See #30799.

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


git-svn-id: http://core.svn.wordpress.org/trunk@31071 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-08 07:05:25 +00:00
Drew Jaynes 23707b1ada Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP.
The style for marking parameters optional in inline PHP docs is: `@param type $var Optional. Description. Accepts. Default.`, where Accepts can be omitted on a case-by-case basis.

Props coffee2code.
Fixes #30591.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30743 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-06 21:24:45 +00:00
Drew Jaynes ad297dab6d Correctly capitalize JavaScript throughout core docs.
Fixes #30569.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30685 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-02 00:31:22 +00:00