Commit Graph

62 Commits

Author SHA1 Message Date
Boone Gorges
3b7187eade Fix 'exclude_tree' in wp_list_categories().
The 'exclude_tree' parameter must be compatible with 'hierarchical';
previously, 'hierarchical' canceled it out. This changeset also makes it so
that 'exclude_tree' is compatible with 'exclude'. When both are passed, and
'hierarchical' is true, the descendant trees of terms in both parameters will
be excluded from matched terms.

Props tott, webord, MikeHansenMe.
Fixes #12981.

git-svn-id: https://develop.svn.wordpress.org/trunk@34696 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-29 19:11:12 +00:00
Boone Gorges
de0b5c846f Introduce 'the_category_list' filter.
Used to filter categories as structured data, before building markup in
`get_the_category_list()`.

We use this filter in addition to upstream filters (such as
'get_the_categories'`) because those upstream filters are used in numerous
contexts, while `'the_category_list'` is always used for generating markup
for display.

Props KevinB, ericlewis, SergeyBiryukov, DrewAPicture.
Fixes #9227.

git-svn-id: https://develop.svn.wordpress.org/trunk@34625 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-27 02:21:43 +00:00
Boone Gorges
c39a4a6447 Pass the post ID to the get_the_categories filter.
Props SergeyBiryukov.
See #9227.

git-svn-id: https://develop.svn.wordpress.org/trunk@34624 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-27 02:16:23 +00:00
Drew Jaynes
fa11dc9c5b Docs: Clarify the file header summary and version for wp-includes/category-template.php.
See #33413. See #33701.


git-svn-id: https://develop.svn.wordpress.org/trunk@34420 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-22 14:22:48 +00:00
Scott Taylor
adfd136bee 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@34110 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-14 03:09:37 +00:00
Boone Gorges
27c8977af9 In wp_list_categories(), 'current_category' should accept an array of values.
This allows the 'current-cat' or 'current-cat-parent' classes to be applied
to more than one item in the list.

Props vilkatis.
Fixes #33565.

git-svn-id: https://develop.svn.wordpress.org/trunk@33804 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-29 19:45:35 +00:00
Boone Gorges
718787cd18 Rename param added to wp_list_categories() in [33764] to 'hide_title_if_empty'.
Props vilkatis, DrewAPicture.
Fixes #33565.

git-svn-id: https://develop.svn.wordpress.org/trunk@33767 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-27 02:08:31 +00:00
Boone Gorges
1f7031e2f8 After [33764], fix docblock formatting for wp_list_categories().
See #33460.

git-svn-id: https://develop.svn.wordpress.org/trunk@33765 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-26 19:42:02 +00:00
Boone Gorges
a684d5d19d Introduce hide_title_if_no_cats parameter to wp_list_categories().
When generating a `<ul>` using `wp_list_categories()`, a title `<li>` element
is put at the top of the term list. Current behavior is that this title `<li>`
appears even when no terms are found. The new `hide_title_if_no_cats` param
allows developers to specify that the title should be hidden when the term list
is empty.

Props vilkatis.
Fixes #33460.

git-svn-id: https://develop.svn.wordpress.org/trunk@33764 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-26 19:41:55 +00:00
Boone Gorges
91a24f5cca Use proper array documentation formatting for wp_list_categories().
This changeset also corrects a few parameter descriptions, and adds a few that
were previously missing.

Fixes #33556.

git-svn-id: https://develop.svn.wordpress.org/trunk@33763 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-26 15:29:35 +00:00
Boone Gorges
c1b8f1f72a In Walker_CategoryDropdown::start_el(), cast values to strings before deciding whether to append 'selected' attribute.
As of [32484], `wp_dropdown_categories()` uses the `$value_field` value to
decide whether a given `<option>` should be 'selected'. However, `$value_field`
can refer to a value that is a string, such as a category's slug. This causes
problems when doing a loose comparison (`==`) with the value of the `'selected'`
parameter, which defaults to `0`, because when doing a loose comparison
between an integer and a string, PHP will cast the string to an integer. This
creates false matches, resulting in `<option>` elements getting a 'selected'
attribute incorrectly.

We address the issue by casting the comparison values to strings, and then
using the strict comparison operator `===`.

Fixes #33452 for trunk.

git-svn-id: https://develop.svn.wordpress.org/trunk@33681 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-21 01:10:34 +00:00
Drew Jaynes
c1e158cf87 Update the description for get_the_category() with helpful information for the proper function to use for custom taxonomies.
Also adds a missing return description.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@33318 602fd350-edb4-49c9-b593-d223f7449a82
2015-07-17 22:57:20 +00:00
Boone Gorges
10d81a3fe5 Introduce 'wp_generate_tag_cloud_data' filter.
This filter allows developers to modify the data that is used to create tag
clouds, without having to manipulate the tag cloud markup directly.

As part of the refactor, this changeset also adds a few unit tests for the way
`wp_generate_tag_cloud()` generates the 'title' attribute, as well as
improvements to output escaping.

Props flixos90, ysalame.
Fixes #24656.

git-svn-id: https://develop.svn.wordpress.org/trunk@32996 602fd350-edb4-49c9-b593-d223f7449a82
2015-06-29 14:15:59 +00:00
Scott Taylor
39ef6a72c5 Use void instead of null where appropriate when pipe-delimiting @return types. If a @return only contains void, remove it.
See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32568 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-24 05:39:47 +00:00
Scott Taylor
febd12c957 Clean up @global doc blocks/imports for class-wp-customizer-*.php and friends.
See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32542 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-22 05:05:19 +00:00
Scott Taylor
51717c41af In category-template.php:
* Clarify/add some `return` docs.
* In `walk_category_tree()` and `walk_category_dropdown_tree()`, make behavior consistent and don't pass `$walker` by-reference - it is no longer necessary to do that with object instances.

See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32531 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-21 21:04:32 +00:00
Boone Gorges
1a8bd3bf07 In category dropdown, 'selected' should match against 'value_field'.
Props tlexcellent.
Fixes #32330.

git-svn-id: https://develop.svn.wordpress.org/trunk@32484 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-11 13:10:19 +00:00
Boone Gorges
000f4f98b4 In wp_list_categories(), 'All' link should point to post type archive if taxonomy is not registered for 'post' or 'page'.
Instead, we point to the post type archive of the first registered
object_type that supports archives.

Props stevegrunwell, hrishiv90, boonebgorges.
Fixes #21881.

git-svn-id: https://develop.svn.wordpress.org/trunk@32292 602fd350-edb4-49c9-b593-d223f7449a82
2015-04-24 14:56:37 +00:00
Drew Jaynes
4d57614cef Fix description alignment for the category_css_class filter docs.
See [31027]. See #31888.


git-svn-id: https://develop.svn.wordpress.org/trunk@32026 602fd350-edb4-49c9-b593-d223f7449a82
2015-04-05 14:48:06 +00:00
Boone Gorges
b4420cb788 Use backticks when describing the value_field parameter, er, argument.
See [32020].

git-svn-id: https://develop.svn.wordpress.org/trunk@32021 602fd350-edb4-49c9-b593-d223f7449a82
2015-04-04 22:56:04 +00:00
Drew Jaynes
bdbe9f7b1e The value_field argument is an argument per core vernacular, not a parameter.
See [31006]. See #31888.


git-svn-id: https://develop.svn.wordpress.org/trunk@32020 602fd350-edb4-49c9-b593-d223f7449a82
2015-04-04 22:41:28 +00:00
Drew Jaynes
88b0b7d9da Update the DocBlock for wp_dropdown_categories() to reflect that the entire $args parameter array is optional instead of individual arugments.
See #30306.


git-svn-id: https://develop.svn.wordpress.org/trunk@31357 602fd350-edb4-49c9-b593-d223f7449a82
2015-02-06 09:03:26 +00:00
Scott Taylor
5acc6bdb58 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@31188 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-16 01:05:52 +00:00
Boone Gorges
8d990ce6f8 Introduce 'category_css_classes' filter.
Paralleling the 'page_css_classes' filter, this allows developers to modify
the list of CSS classes used when creating category list markup via
`Walker_Category`.

Props sivel.
Fixes #16497.

git-svn-id: https://develop.svn.wordpress.org/trunk@31027 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-03 02:30:14 +00:00
Boone Gorges
fd8b7faff6 In Walker_Category, don't generate list elements for empty cat names.
This change allows the 'list_cats' filter to be used to suppress certain
items in category lists, without creating invalid or superfluous markup.

Props samo9789.
Fixes #16792.

git-svn-id: https://develop.svn.wordpress.org/trunk@31025 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-03 02:04:17 +00:00
Boone Gorges
4cead42b26 Introduce 'name' parameter for get_terms().
This enhancement requires a modification in the way that `wp_dropdown_categories()`
prepares its arguments for `get_terms()`, so that its unrelated 'name' param is
not mistaken for the new 'name' argument in `get_terms()`.

Props danielbachhuber.
Fixes #30611.

git-svn-id: https://develop.svn.wordpress.org/trunk@31024 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-02 21:33:33 +00:00
Boone Gorges
ae6575685c In wp_dropdown_categories(), allow the term field used to populate option valuesto be specified.
The new 'value_field' parameter makes it possible to set term slugs (or some
other term property) as the 'value' attribute of the option elements generated
by `wp_dropdown_categories()`. This additional flexibility reduces the effort
required to translate term_id to other term fields when processing form
submissions that include values from taxonomy dropdowns. See #30865 for a
use case.

Props collinsinternet.
Fixes #30306.

git-svn-id: https://develop.svn.wordpress.org/trunk@31006 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-30 21:30:16 +00:00
Boone Gorges
06b820a989 Use proper hash notation for wp_dropdown_categories() docblock.
See #30306.

git-svn-id: https://develop.svn.wordpress.org/trunk@31005 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-30 20:48:34 +00:00
Scott Taylor
218dd4fd6b For clarity, initialize some arrays that previously were only assigned via short circuit in loops.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@30982 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-20 22:46:53 +00:00
Scott Taylor
4d46475b3d Improve various @param docs for src/wp-includes/*.
See #30224.


git-svn-id: https://develop.svn.wordpress.org/trunk@30681 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-01 01:33:34 +00:00
Drew Jaynes (DrewAPicture)
e587324180 Docs Formatting: Backtick-escape inline code for all remaining dynamic hook docs in wp-includes/*.
Affects DocBlocks for the following hooks:
* `auth_post_meta_{$meta_key}`
* `term_links-$taxonomy`
* `customize_render_control_ . $this->id`
* `customize_render_panel_{$this->id}`
* `customize_render_section_{$this->id}`
* `customize_preview_{$this->id}`
* `customize_save_ . $this->id_data[ 'base' ]`
* `customize_update_ . $this->type`
* `customize_value_ . $this->id_data[ 'base' ]`
* `customize_sanitize_js_{$this->id}`
* `comment_form_field_{$name}`
* `comment_{$old_status}_to_{$new_status}`
* `comment_{$new_status}_{$comment->comment_type}`
* `extra_{$context}_headers`
* `get_template_part_{$slug}`
* `get_the_generator_{$type}`
* `get_{$adjacent}_post_join`
* `get_{$adjacent}_post_where`
* `get_{$adjacent}_post_sort`
* `{$adjacent}_post_rel_link`
* `{$adjacent}_post_link`
* `{$adjacent}_image_link`
* `blog_option_{$option}`
* `$permastructname . _rewrite_rules`
* `{$type}_template`
* `theme_mod_{$name}`
* `pre_set_theme_mod_$name`
* `current_theme_supports-{$feature}`
* `get_user_option_{$option}`
* `edit_user_{$field}`
* `pre_user_{$field}`
* `user_{$field}`

See #30552.


git-svn-id: https://develop.svn.wordpress.org/trunk@30656 602fd350-edb4-49c9-b593-d223f7449a82
2014-11-30 12:09:56 +00:00
Drew Jaynes (DrewAPicture)
3cc10d77a0 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@30105 602fd350-edb4-49c9-b593-d223f7449a82
2014-10-30 01:04:55 +00:00
Sergey Biryukov
c943d6d816 Additional @return clarifications for get_the_terms(), get_the_tag_list(), and get_the_term_list().
see #29183.

git-svn-id: https://develop.svn.wordpress.org/trunk@29475 602fd350-edb4-49c9-b593-d223f7449a82
2014-08-12 23:47:23 +00:00
John Blackbourn
ccc0673612 Docblock corrections for get_the_terms() function and corresponding filter, and registered_taxonomy action. Fixes #29183.
git-svn-id: https://develop.svn.wordpress.org/trunk@29467 602fd350-edb4-49c9-b593-d223f7449a82
2014-08-11 21:16:52 +00:00
Scott Taylor
2cd825a21b Cleanup for switch statements:
* Move `default` to the bottom in `WP_Theme_Install_List_Table`
* `switch/endswitch` syntax is not supported in Hack. Switch to `switch (...) {  .... }` syntax. (A few template-type instances linger).

Fixes #28409.
See #27881.



git-svn-id: https://develop.svn.wordpress.org/trunk@28633 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-30 17:57:51 +00:00
Sergey Biryukov
191705a964 Fix inversed logic in Walker_Category::start_el(). see [28359].
Correct 'use_desc_for_title' parameter description.

see #26557.

git-svn-id: https://develop.svn.wordpress.org/trunk@28572 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-24 13:41:11 +00:00
Drew Jaynes (DrewAPicture)
cff4631f00 Add inline documentation for the option_none_value argument added to wp_dropdown_users|categories() in [28564].
Fixes #16625.


git-svn-id: https://develop.svn.wordpress.org/trunk@28570 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-24 05:38:06 +00:00
Scott Taylor
cd7d3f2ee8 wp_dropdown_pages() allows option_none_value to be passed. Add that arg to the $defaults for wp_dropdown_users() and wp_dropdown_categories() as well.
Props solarissmoke. 
Fixes #16625.


git-svn-id: https://develop.svn.wordpress.org/trunk@28564 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-23 20:46:18 +00:00
Scott Taylor
1d13dc8a85 Add access modifiers to methods/members in Walker_Category and Walker_CategoryDropdown.
See #27881, #22234.


git-svn-id: https://develop.svn.wordpress.org/trunk@28504 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-19 05:22:38 +00:00
Scott Taylor
5c28e2986c In Walker_Category::start_el(), $title might not be set when $args are passed multiple levels into walk_category_tree().
See #22400.



git-svn-id: https://develop.svn.wordpress.org/trunk@28438 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-15 19:13:45 +00:00
Scott Taylor
737ad1a878 Eliminate use of extract() in Walker_Category::start_el().
See #22400.


git-svn-id: https://develop.svn.wordpress.org/trunk@28436 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-15 17:57:13 +00:00
Scott Taylor
cc64187e28 Eliminate use of extract() in wp_generate_tag_cloud().
See #22400.


git-svn-id: https://develop.svn.wordpress.org/trunk@28435 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-15 17:47:21 +00:00
Scott Taylor
7793a90fd1 Eliminate use of extract() in wp_list_categories().
See #22400.


git-svn-id: https://develop.svn.wordpress.org/trunk@28434 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-15 17:27:18 +00:00
Scott Taylor
29efc53b6a Eliminate use of extract() in wp_dropdown_categories().
See #22400.


git-svn-id: https://develop.svn.wordpress.org/trunk@28432 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-15 15:47:43 +00:00
Scott Taylor
2808673b0c Remove the title attribute from markup generated in wp-includes/category-template.php:
* `get_category_parents()`
* `get_the_category_list()`
* `wp_generate_tag_cloud()`
* `Walker_Category::start_el()`	

Props joedolson.
Fixes #26557.	



git-svn-id: https://develop.svn.wordpress.org/trunk@28359 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-10 23:56:12 +00:00
Scott Taylor
815adc833a Popular tags' edit links should respect the current post type. Adds unit test.
Props mordauk, fahmiadib.
Fixes #25566.



git-svn-id: https://develop.svn.wordpress.org/trunk@27720 602fd350-edb4-49c9-b593-d223f7449a82
2014-03-25 18:39:26 +00:00
Andrew Nacin
87bfc847b1 Gracefully fail in wp_generate_tag_cloud() when emptiness is returned from the tag_cloud_sort filter.
props SergeyBiryukov.
fixes #27413.


git-svn-id: https://develop.svn.wordpress.org/trunk@27709 602fd350-edb4-49c9-b593-d223f7449a82
2014-03-25 12:59:17 +00:00
Andrew Nacin
de653fe7ab Clarify the return value of wp_generate_tag_cloud().
props SergeyBiryukov, DrewAPicture.
fixes #27487.


git-svn-id: https://develop.svn.wordpress.org/trunk@27708 602fd350-edb4-49c9-b593-d223f7449a82
2014-03-25 12:55:11 +00:00
Drew Jaynes (DrewAPicture)
7002a26178 Inline documentation for hooks in wp-includes/category-template.php.
Props kpdesign for the cleanup.
Fixes #27432.


git-svn-id: https://develop.svn.wordpress.org/trunk@27666 602fd350-edb4-49c9-b593-d223f7449a82
2014-03-24 01:34:46 +00:00
Scott Taylor
dad0455ef9 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.



git-svn-id: https://develop.svn.wordpress.org/trunk@27521 602fd350-edb4-49c9-b593-d223f7449a82
2014-03-13 04:03:06 +00:00