<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34510] trunk/src/wp-includes/taxonomy-functions.php: Docs: Convert the `$args` parameter description in the `register_taxonomy()` DocBlock to a hash notation.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34510">34510</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34510","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-24 19:11:53 +0000 (Thu, 24 Sep 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Convert the `$args` parameter description in the `register_taxonomy()` DocBlock to a hash notation.
Also standardizes the DocBlock summary.
Props johnbillion.
Fixes <a href="https://core.trac.wordpress.org/ticket/33991">#33991</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyfunctionsphp">trunk/src/wp-includes/taxonomy-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludestaxonomyfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/taxonomy-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy-functions.php 2015-09-24 18:51:13 UTC (rev 34509)
+++ trunk/src/wp-includes/taxonomy-functions.php 2015-09-24 19:11:53 UTC (rev 34510)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -260,66 +260,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Create or modify a taxonomy object. Do not use before init.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Creates or modifies a taxonomy object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Note: Do not use before the {@see 'init'} hook.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * A simple function for creating or modifying a taxonomy object based on the
</span><span class="cx" style="display: block; padding: 0 10px"> * parameters given. The function will accept an array (third optional
</span><span class="cx" style="display: block; padding: 0 10px"> * parameter), along with strings for the taxonomy name and another string for
</span><span class="cx" style="display: block; padding: 0 10px"> * the object type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Nothing is returned, so expect error maybe or use taxonomy_exists() to check
- * whether taxonomy exists.
- *
- * Optional $args contents:
- *
- * - label - Name of the taxonomy shown in the menu. Usually plural. If not set, labels['name'] will be used.
- * - labels - An array of labels for this taxonomy.
- * * By default tag labels are used for non-hierarchical types and category labels for hierarchical ones.
- * * You can see accepted values in {@link get_taxonomy_labels()}.
- * - description - A short descriptive summary of what the taxonomy is for. Defaults to blank.
- * - public - If the taxonomy should be publicly queryable.
- * * Defaults to true.
- * - hierarchical - Whether the taxonomy is hierarchical (e.g. category). Defaults to false.
- * - show_ui - Whether to generate and allow a UI for managing terms in this taxonomy in the admin.
- * * If not set, the default is inherited from public.
- * - show_in_menu - Whether to show the taxonomy in the admin menu.
- * * If true, the taxonomy is shown as a submenu of the object type menu.
- * * If false, no menu is shown.
- * * show_ui must be true.
- * * If not set, the default is inherited from show_ui.
- * - show_in_nav_menus - Makes this taxonomy available for selection in navigation menus.
- * * If not set, the default is inherited from public.
- * - show_tagcloud - Whether to list the taxonomy in the Tag Cloud Widget.
- * * If not set, the default is inherited from show_ui.
- * - show_in_quick_edit - Whether to show the taxonomy in the quick/bulk edit panel.
- * * It not set, the default is inherited from show_ui.
- * - show_admin_column - Whether to display a column for the taxonomy on its post type listing screens.
- * * Defaults to false.
- * - meta_box_cb - Provide a callback function for the meta box display.
- * * If not set, defaults to post_categories_meta_box for hierarchical taxonomies
- * and post_tags_meta_box for non-hierarchical.
- * * If false, no meta box is shown.
- * - capabilities - Array of capabilities for this taxonomy.
- * * You can see accepted values in this function.
- * - rewrite - Triggers the handling of rewrites for this taxonomy. Defaults to true, using $taxonomy as slug.
- * * To prevent rewrite, set to false.
- * * To specify rewrite rules, an array can be passed with any of these keys
- * * 'slug' => string Customize the permastruct slug. Defaults to $taxonomy key
- * * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true.
- * * 'hierarchical' => bool Either hierarchical rewrite tag or not. Defaults to false.
- * * 'ep_mask' => const Assign an endpoint mask.
- * * If not specified, defaults to EP_NONE.
- * - query_var - Sets the query_var key for this taxonomy. Defaults to $taxonomy key
- * * If false, a taxonomy cannot be loaded at ?{query_var}={term_slug}
- * * If specified as a string, the query ?{query_var_string}={term_slug} will be valid.
- * - update_count_callback - Works much like a hook, in that it will be called when the count is updated.
- * * Defaults to _update_post_term_count() for taxonomies attached to post types, which then confirms
- * that the objects are published before counting them.
- * * Defaults to _update_generic_term_count() for taxonomies attached to other object types, such as links.
- * - _builtin - true if this taxonomy is a native or "built-in" taxonomy. THIS IS FOR INTERNAL USE ONLY!
- *
- * @todo Document $args as a hash notation.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0 Introduced `show_in_quick_edit` argument.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 The `show_ui` argument is now enforced on the term editing screen.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -329,7 +278,65 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $taxonomy Taxonomy key, must not exceed 32 characters.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $object_type Name of the object type for the taxonomy object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array|string $args See optional args description above.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array|string $args {
+ * Optional. Array or query string of arguments for registering a taxonomy.
+ *
+ * @type string $label Name of the taxonomy shown in the menu. Usually plural. If not set,
+ * `$labels['name']` will be used.
+ * @type array $labels An array of labels for this taxonomy. By default, Tag labels are used for
+ * non-hierarchical taxonmies, and Category labels are used for hierarchical
+ * taxonomies. See accepted values in get_taxonomy_labels().
+ * Default empty array.
+ * @type string $description A short descriptive summary of what the taxonomy is for. Default empty.
+ * @type bool $public Whether the taxonomy is publicly queryable. Default true.
+ * @type bool $hierarchical Whether the taxonomy is hierarchical. Default false.
+ * @type bool $show_ui Whether to generate and allow a UI for managing terms in this taxonomy in
+ * the admin. If not set, the default is inherited from `$public`
+ * (default true).
+ * @type bool $show_in_menu Whether to show the taxonomy in the admin menu. If true, the taxonomy is
+ * shown as a submenu of the object type menu. If false, no menu is shown.
+ * `$show_ui` must be true. If not set, default is inherited from `$show_ui`
+ * (default true).
+ * @type bool $show_in_nav_menus Makes this taxonomy available for selection in navigation menus. If not
+ * set, the default is inherited from `$public` (default true).
+ * @type bool $show_tagcloud Whether to list the taxonomy in the Tag Cloud Widget controls. If not set,
+ * the default is inherited from `$show_ui` (default true).
+ * @type bool $show_in_quick_edit Whether to show the taxonomy in the quick/bulk edit panel. It not set,
+ * the default is inherited from `$show_ui` (default true).
+ * @type bool $show_admin_column Whether to display a column for the taxonomy on its post type listing
+ * screens. Default false.
+ * @type bool|callable $meta_box_cb Provide a callback function for the meta box display. If not set,
+ * post_categories_meta_box() is used for hierarchical taxonomies, and
+ * post_tags_meta_box() is used for non-hierarchical. If false, no meta
+ * box is shown.
+ * @type array $capabilities {
+ * Array of capabilities for this taxonomy.
+ *
+ * @type string $manage_terms Default 'manage_categories'.
+ * @type string $edit_terms Default 'manage_categories'.
+ * @type string $delete_terms Default 'manage_categories'.
+ * @type string $assign_terms Default 'edit_posts'.
+ * }
+ * @type bool|array $rewrite {
+ * Triggers the handling of rewrites for this taxonomy. Default true, using $taxonomy as slug. To prevent
+ * rewrite, set to false. To specify rewrite rules, an array can be passed with any of these keys:
+ *
+ * @type string $slug Customize the permastruct slug. Default `$taxonomy` key.
+ * @type bool $with_front Should the permastruct be prepended with WP_Rewrite::$front. Default true.
+ * @type bool $hierarchical Either hierarchical rewrite tag or not. Default false.
+ * @type int $ep_mask Assign an endpoint mask. Default `EP_NONE`.
+ * }
+ * @type string $query_var Sets the query var key for this taxonomy. Default `$taxonomy` key. If
+ * false, a taxonomy cannot be loaded at `?{query_var}={term_slug}`. If a
+ * string, the query `?{query_var}={term_slug}` will be valid.
+ * @type callable $update_count_callback Works much like a hook, in that it will be called when the count is
+ * updated. Default _update_post_term_count() for taxonomies attached
+ * to post types, which confirms that the objects are published before
+ * counting them. Default _update_generic_term_count() for taxonomies
+ * attached to other object types, such as users.
+ * @type bool $_builtin This taxonomy is a "built-in" taxonomy. INTERNAL USE ONLY!
+ * Default false.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Error|void WP_Error, if errors.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
</span></span></pre>
</div>
</div>
</body>
</html>