<!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>[45419] trunk/src/wp-includes: Docs: Standardise documentation for capability-related variadic functions.</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 { white-space: pre-line; 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/45419">45419</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/45419","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-05-25 22:26:22 +0000 (Sat, 25 May 2019)</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: Standardise documentation for capability-related variadic functions.
See <a href="https://core.trac.wordpress.org/ticket/37402">#37402</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescapabilitiesphp">trunk/src/wp-includes/capabilities.php</a></li>
<li><a href="#trunksrcwpincludesclasswpuserphp">trunk/src/wp-includes/class-wp-user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescapabilitiesphp"></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/capabilities.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/capabilities.php 2019-05-25 21:58:18 UTC (rev 45418)
+++ trunk/src/wp-includes/capabilities.php 2019-05-25 22:26:22 UTC (rev 45419)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,8 +7,18 @@
</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">- * Map meta capabilities to primitive capabilities.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Maps meta capabilities to primitive capabilities.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This function also accepts an ID of an object to map against if the capability is a meta capability. Meta
+ * capabilities such as `edit_post` and `edit_user` are capabilities used by this function to map to primitive
+ * capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`.
+ *
+ * Example usage:
+ *
+ * map_meta_cap( 'edit_posts', $user->ID );
+ * map_meta_cap( 'edit_post', $user->ID, $post->ID );
+ * map_meta_cap( 'edit_post_meta', $user->ID, $post->ID, $meta_key );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * This does not actually compare whether the user ID has the actual capability,
</span><span class="cx" style="display: block; padding: 0 10px"> * just what the capability or capabilities are. Meta capability list value can
</span><span class="cx" style="display: block; padding: 0 10px"> * be 'delete_user', 'edit_user', 'remove_user', 'promote_user', 'delete_post',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,12 +28,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $post_type_meta_caps Used to get post type meta capabilities.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $cap Capability name.
- * @param int $user_id User ID.
- * @param int $object_id Optional. ID of the specific object to check against if `$cap` is a "meta" cap.
- * "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used
- * by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts',
- * 'edit_others_posts', etc. The parameter is accessed via func_get_args().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $cap Capability name.
+ * @param int $user_id User ID.
+ * @param mixed ...$args Optional further parameters, typically starting with an object ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Actual capabilities for meta capability.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function map_meta_cap( $cap, $user_id ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -615,8 +622,18 @@
</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">- * Whether the current user has a specific capability.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns whether the current user has the specified capability.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta
+ * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to
+ * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`.
+ *
+ * Example usage:
+ *
+ * current_user_can( 'edit_posts' );
+ * current_user_can( 'edit_post', $post->ID );
+ * current_user_can( 'edit_post_meta', $post->ID, $meta_key );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * While checking against particular roles in place of a capability is supported
</span><span class="cx" style="display: block; padding: 0 10px"> * in part, this practice is discouraged as it may produce unreliable results.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -628,11 +645,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see map_meta_cap()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $capability Capability name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $object_id Optional. ID of the specific object to check against if `$capability` is a "meta" cap.
- * "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used
- * by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts',
- * 'edit_others_posts', etc. Accessed via func_get_args() and passed to WP_User::has_cap(),
- * then map_meta_cap().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed ...$args Optional further parameters, typically starting with an object ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the current user has the given capability. If `$capability` is a meta cap and `$object_id` is
</span><span class="cx" style="display: block; padding: 0 10px"> * passed, whether the current user has the given meta capability for the given object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -650,12 +663,23 @@
</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">- * Whether the current user has a specific capability for a given site.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns whether the current user has the specified capability for a given site.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta
+ * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to
+ * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`.
+ *
+ * Example usage:
+ *
+ * current_user_can_for_blog( $blog_id, 'edit_posts' );
+ * current_user_can_for_blog( $blog_id, 'edit_post', $post->ID );
+ * current_user_can_for_blog( $blog_id, 'edit_post_meta', $post->ID, $meta_key );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $blog_id Site ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $capability Capability name.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed ...$args Optional further parameters, typically starting with an object ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the user has the given capability.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function current_user_can_for_blog( $blog_id, $capability ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -683,12 +707,23 @@
</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">- * Whether the author of the supplied post has a specific capability.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns whether the author of the supplied post has the specified capability.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta
+ * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to
+ * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`.
+ *
+ * Example usage:
+ *
+ * author_can( $post, 'edit_posts' );
+ * author_can( $post, 'edit_post', $post->ID );
+ * author_can( $post, 'edit_post_meta', $post->ID, $meta_key );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_Post $post Post ID or post object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $capability Capability name.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed ...$args Optional further parameters, typically starting with an object ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the post author has the given capability.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function author_can( $post, $capability ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -709,12 +744,23 @@
</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">- * Whether a particular user has a specific capability.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns whether a particular user has the specified capability.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta
+ * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to
+ * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`.
+ *
+ * Example usage:
+ *
+ * user_can( $user->ID, 'edit_posts' );
+ * user_can( $user->ID, 'edit_post', $post->ID );
+ * user_can( $user->ID, 'edit_post_meta', $post->ID, $meta_key );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_User $user User ID or object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $capability Capability name.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed ...$args Optional further parameters, typically starting with an object ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the user has the given capability.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function user_can( $user, $capability ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpuserphp"></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/class-wp-user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-user.php 2019-05-25 21:58:18 UTC (rev 45418)
+++ trunk/src/wp-includes/class-wp-user.php 2019-05-25 22:26:22 UTC (rev 45419)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -712,8 +712,18 @@
</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">- * Whether the user has a specific capability.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns whether the user has the specified capability.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta
+ * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to
+ * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`.
+ *
+ * Example usage:
+ *
+ * $user->has_cap( 'edit_posts' );
+ * $user->has_cap( 'edit_post', $post->ID );
+ * $user->has_cap( 'edit_post_meta', $post->ID, $meta_key );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * While checking against a role in place of a capability is supported in part, this practice is discouraged as it
</span><span class="cx" style="display: block; padding: 0 10px"> * may produce unreliable results.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -721,12 +731,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see map_meta_cap()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $cap Capability name.
- * @param int ...$object_id Optional. ID of a specific object to check against if `$cap` is a "meta" capability.
- * Meta capabilities such as `edit_post` and `edit_user` are capabilities used by
- * by the `map_meta_cap()` function to map to primitive capabilities that a user or
- * role has, such as `edit_posts` and `edit_others_posts`.
- * @return bool Whether the user has the given capability, or, if `$object_id` is passed, whether the user has
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $cap Capability name.
+ * @param mixed ...$args Optional further parameters, typically starting with an object ID.
+ * @return bool Whether the user has the given capability, or, if an object ID is passed, whether the user has
</ins><span class="cx" style="display: block; padding: 0 10px"> * the given capability for that object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function has_cap( $cap ) {
</span></span></pre>
</div>
</div>
</body>
</html>