Commit Graph

101 Commits

Author SHA1 Message Date
John Blackbourn b13e73d05c Docs: Document more parameters and properties using typed array notation.
See #41756

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


git-svn-id: http://core.svn.wordpress.org/trunk@42705 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-03-25 18:10:32 +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
Sergey Biryukov 9d7ea04936 I18N: Merge similar strings in `_deprecated_argument()` calls.
Add translator comments.

Props ramiy, SergeyBiryukov.
Fixes #39020.
Built from https://develop.svn.wordpress.org/trunk@40028


git-svn-id: http://core.svn.wordpress.org/trunk@39965 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-01-29 11:50:41 +00:00
John Blackbourn b9033ad6a1 Docs: Improve the documentation for parameters which accept `OBJECT`, `ARRAY_A`, and `ARRAY_N` as parameters.
See #37770

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


git-svn-id: http://core.svn.wordpress.org/trunk@39128 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-11-09 23:00:32 +00:00
Sergey Biryukov 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
Drew Jaynes 9cb5247392 Docs: Standardize filter docs in remaining wp-includes/* files to use third-person singular verbs per the inline documentation standards for PHP.
See #36913.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37486 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-22 18:50:28 +00:00
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 fe3b007fdd Docs: Remove inline `@see` tags from function, class, and method references in inline docs.
Known functions, classes, and methods are now auto-linked in Code Reference pages following #meta1483.

Note: Hook references are still linked via inline `@see` tags due to the unlikelihood of reliably matching for known hooks based on a RegEx pattern.

See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37308 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-02 04:00:28 +00:00
Boone Gorges cac6d65780 Improve error handling in `get_categories()`.
When passed an invalid `'taxonomy'`, `get_terms()` will return a `WP_Error`
object. This object should not be blindly cast to an array. Instead, an empty
array should be returned, to indicate that no matching terms have been found.

Props virgodesign, sebastian.pisula.
Fixes #36227.
Built from https://develop.svn.wordpress.org/trunk@36988


git-svn-id: http://core.svn.wordpress.org/trunk@36955 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-14 13:53:28 +00:00
Drew Jaynes 94fdeabe27 Docs: Document the `$args` parameter for `get_categories()` as a hash notation.
The only specific default for `get_categories()` is `$taxonomy` with a value of 'category', all the other arguments are documented separately in `get_terms()`.

See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36443 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-04 14:50:26 +00:00
Drew Jaynes 6bbb34818c Docs: Reference `get_terms()` for arguments available in `get_categories()`.
See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@36442 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-04 14:38:28 +00:00
Andrew Nacin 1579e45d41 Simplify the include graph after work to split out classes.
see #33413. More details there.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35682 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-11-20 07:24:30 +00:00
Drew Jaynes d5c824beb7 Docs: Clarify the file header for wp-includes/category.php.
See #33413. See #33701.

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


git-svn-id: http://core.svn.wordpress.org/trunk@34382 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-22 14:20:24 +00:00
Scott Taylor 172e37b007 Move `Walker_Category` and `Walker_CategoryDropdown` into their own files via `svn cp`. Remove them from `category-template.php`. Load them in `category.php`. `svn cp` `category.php` over to `category-functions.php`, which also loads now in `category.php`.
See #33413.

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


git-svn-id: http://core.svn.wordpress.org/trunk@34078 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-14 03:10:24 +00:00
Scott Taylor bd8fafea54 Use `void` instead of `null` where appropriate when pipe-delimiting `@return` types. If a `@return` only contains `void`, remove it.
See #32444.

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


git-svn-id: http://core.svn.wordpress.org/trunk@32538 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-24 05:40:25 +00:00
Scott Taylor ed4aafa692 In `category.php`:
* Clarify some `return` docs.
* In `_make_cat_compat()`, ensure that `WP_Error` is not decorated

See #32444.

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


git-svn-id: http://core.svn.wordpress.org/trunk@32502 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-21 21:18:24 +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
Drew Jaynes 254ff0a4c9 Add inline `@see` tags to the docs for the `get_categories_taxonomy` hook.
Props tw2113.
Fixes #30310.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30368 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-17 17:37: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
Sergey Biryukov 6d5b7ea58f Deprecate get_all_category_ids(). Suggest get_terms() as a replacement.
props winterDev, MikeHansenMe.
fixes #21200.
Built from https://develop.svn.wordpress.org/trunk@28679


git-svn-id: http://core.svn.wordpress.org/trunk@28497 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-05 16:25:14 +00:00
Scott Taylor cd2e279d65 Avoid a notice in `get_the_category_by_ID()` when `is_wp_error( $term )` is false but `$term->name` is not set. Clarify the `@return` value of `get_category()` and `get_tag()` which return the same possible types as `get_term()`, which they wrap.
Props ericmann, SergeyBiryukov.
Fixes #25429.


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


git-svn-id: http://core.svn.wordpress.org/trunk@27364 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-03-13 04:04:15 +00:00
Andrew Nacin 70fd806759 Revert r25824:25875 from the core.svn.wordpress.org repository.
These commits were accidentally re-synced commits from develop.svn.wordpress.org due to a race condition. Thankfully, the history of this repository matters fairly little. It also happened only for trunk.


git-svn-id: http://core.svn.wordpress.org/trunk@25876 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-10-25 02:29:52 +00:00
Andrew Nacin 8ae8e01b67 Remove the old wp_auto_updates_maybe_update cron event. Schedule the new wp_maybe_auto_update event at 7 a.m. and 7 p.m. in the site's timezone.
see #27704.

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


git-svn-id: http://core.svn.wordpress.org/trunk@25825 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-10-24 22:53:14 +00:00
Ryan Boren b87d4b77e5 Pinking shears
Built from https://develop.svn.wordpress.org/trunk@25880


git-svn-id: http://core.svn.wordpress.org/trunk@25792 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-10-23 14:38:10 +00:00
Drew Jaynes c79cb5b43f Inline documentation for hooks in wp-includes/category.php.
Props ben.moody
Fixes #25503.

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


git-svn-id: http://core.svn.wordpress.org/trunk@25637 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-10-08 00:22:09 +00:00
Scott Taylor 6a5d2f8fb0 Rather than adding a `taxonomy` arg to `get_category()`, convert all uses of `get_category()` in core to `get_term()`. By doing so, we negate the need to call `_make_cat_compat()` in a few places that are only looking for a single property.
Fixes #8722.


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


git-svn-id: http://core.svn.wordpress.org/trunk@25578 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-10-02 19:59:10 +00:00
Ryan Boren 06ee370814 Pinking shears
git-svn-id: http://core.svn.wordpress.org/trunk@22634 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-11-17 15:11:29 +00:00
Andrew Nacin 30078a53ad Remove bogus optional value for get_cat_ID(). (Incorrect usage will result in a warning.) props Latz. fixes #21201.
git-svn-id: http://core.svn.wordpress.org/trunk@22260 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-10-18 01:40:42 +00:00
Ryan Boren c15d7d3a95 Avoid 'Only variables should be assigned by reference' warning. Props wonderboymusic. see #21865
git-svn-id: http://core.svn.wordpress.org/trunk@22116 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-10-04 18:30:57 +00:00
Ryan Boren f483a85676 Remove unnecessary return by refs. Props wonderboymusic. fixes #21839
git-svn-id: http://core.svn.wordpress.org/trunk@21792 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-09-10 17:00:11 +00:00
ryan e3b46b25d3 Lose EOF ?>. Clean up EOF newlines. fixes #12307
git-svn-id: http://svn.automattic.com/wordpress/trunk@19712 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-01-08 17:01:11 +00:00
ryan 616c35e71c One newline is enough.
git-svn-id: http://svn.automattic.com/wordpress/trunk@19684 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-01-05 20:10:39 +00:00
ryan 85304c2dc7 Introduce term_is_ancestor_of(). Finish taxonomy support for wp_insert_category(). Props garyc40. fixes #15581
git-svn-id: http://svn.automattic.com/wordpress/trunk@19678 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-01-04 22:44:19 +00:00
scribu d2a5add61a Deprecate update_category_cache(). Fixes #15446
git-svn-id: http://svn.automattic.com/wordpress/trunk@16412 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-11-17 00:56:00 +00:00
nacin 3bdcf36888 Account for old type=link (now taxonomy=link_category) in wp_dropdown_categories(). Don't use the deprecated argument in options-writing. Sprinkle in some deprecated warnings. fixes #12630
git-svn-id: http://svn.automattic.com/wordpress/trunk@13754 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-03-18 20:17:15 +00:00
nacin 8bcc5969dc Spelling and grammar fun. Fixes #11875 props cnorris23
git-svn-id: http://svn.automattic.com/wordpress/trunk@13382 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-02-24 20:13:23 +00:00
nacin 09820497cb Fix notice in get_cat_name(). Return empty string if category does not exist, fixes #11737.
git-svn-id: http://svn.automattic.com/wordpress/trunk@13074 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-02-13 02:35:41 +00:00
ryan 58d3776667 Show custom hierarchical taxonomies in the menus. Props dd32. see #11838
git-svn-id: http://svn.automattic.com/wordpress/trunk@12694 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-01-11 19:27:44 +00:00
ryan cedfa0181b Use array calling style. Props Denis-de-Bernardy. see #6647
git-svn-id: http://svn.automattic.com/wordpress/trunk@12515 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2009-12-23 15:31:02 +00:00
ryan bd5457487a Fix typing in cat_is_ancestor_of(). Props filosofo. fixes #9614
git-svn-id: http://svn.automattic.com/wordpress/trunk@11031 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2009-04-21 19:42:28 +00:00
ryan 6ecb1077d7 Deprecae get_catname(). Props filosofo. fixes #9550
git-svn-id: http://svn.automattic.com/wordpress/trunk@10959 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2009-04-16 22:03:45 +00:00
ryan e89192b1a8 Strip trailing whitespace
git-svn-id: http://svn.automattic.com/wordpress/trunk@10150 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-12-09 18:03:31 +00:00
ryan 2fdde1e736 Notice fixes from filosofo and Viper007Bond. see #7509
git-svn-id: http://svn.automattic.com/wordpress/trunk@9506 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-11-04 03:22:24 +00:00
azaozz 14dddc912b Add filter to get_categories(), props Malaiac, fixes #7427
git-svn-id: http://svn.automattic.com/wordpress/trunk@9080 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-10-03 22:09:35 +00:00
westi f7b32217a3 phpDoc corrections for wp-includes. See #7550 props santosj.
git-svn-id: http://svn.automattic.com/wordpress/trunk@8742 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-08-27 06:45:13 +00:00
markjaquith 643218c8fb Whitespacing/coding standards cleanup for category.php
git-svn-id: http://svn.automattic.com/wordpress/trunk@8575 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-08-06 21:06:14 +00:00
markjaquith 74c46749cb Cast to array when using foreach(). Props santosj (and thanks for your perseverance!). fixes #2784
git-svn-id: http://svn.automattic.com/wordpress/trunk@8572 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-08-06 20:31:54 +00:00
westi c68af8c7db PHPDoc updates for category.php. Fixes #5633 props jacobsantos.
git-svn-id: http://svn.automattic.com/wordpress/trunk@8090 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-06-15 09:32:19 +00:00
ryan 6f7d120d5b Remove lingering bit of get_tags cache
git-svn-id: http://svn.automattic.com/wordpress/trunk@6655 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-01-25 01:59:06 +00:00
ryan 2d656cdb15 Remove busted get_tags cache. get_terms does the caching for us. Props josephscott
git-svn-id: http://svn.automattic.com/wordpress/trunk@6651 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2008-01-25 01:19:53 +00:00