<!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>[26126] trunk/src/wp-includes/capabilities.php: Inline documentation for hooks in wp-includes/capabilities.php.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/26126">26126</a></dd>
<dt>Author</dt> <dd>SergeyBiryukov</dd>
<dt>Date</dt> <dd>2013-11-13 04:38:13 +0000 (Wed, 13 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/capabilities.php.
props ptahdunbar, kpdesign.
fixes <a href="http://core.trac.wordpress.org/ticket/25531">#25531</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescapabilitiesphp">trunk/src/wp-includes/capabilities.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescapabilitiesphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/capabilities.php (26125 => 26126)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/capabilities.php 2013-11-13 04:29:27 UTC (rev 26125)
+++ trunk/src/wp-includes/capabilities.php 2013-11-13 04:38:13 UTC (rev 26126)
</span><span class="lines">@@ -378,6 +378,15 @@
</span><span class="cx"> * @return bool True, if user has capability. False, if doesn't have capability.
</span><span class="cx"> */
</span><span class="cx"> function has_cap( $cap ) {
</span><ins>+ /**
+ * Filter which capabilities a role has.
+ *
+ * @since 2.0.0
+ *
+ * @param array $capabilities Array of role capabilities.
+ * @param string $cap Capability name.
+ * @param string $name Role name.
+ */
</ins><span class="cx"> $capabilities = apply_filters( 'role_has_cap', $this->capabilities, $cap, $this->name );
</span><span class="cx"> if ( !empty( $capabilities[$cap] ) )
</span><span class="cx"> return $capabilities[$cap];
</span><span class="lines">@@ -822,6 +831,17 @@
</span><span class="cx"> update_user_meta( $this->ID, $this->cap_key, $this->caps );
</span><span class="cx"> $this->get_role_caps();
</span><span class="cx"> $this->update_user_level_from_caps();
</span><ins>+
+ /**
+ * Fires after the user's role has changed.
+ *
+ * @since 2.9.0
+ * @since 3.6.0 Added $old_roles to include an array of the user's previous roles.
+ *
+ * @param int $user_id The user ID.
+ * @param string $role The new role.
+ * @param array $old_roles An array of the user's previous roles.
+ */
</ins><span class="cx"> do_action( 'set_user_role', $this->ID, $role, $old_roles );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -942,6 +962,17 @@
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Dynamically filter a user's capabilities.
+ *
+ * @since 2.0.0
+ * @since 3.7.0 Added the user object.
+ *
+ * @param array $allcaps An array of all the role's capabilities.
+ * @param array $caps Actual capabilities for meta capability.
+ * @param array $args Optional parameters passed to has_cap(), typically object ID.
+ * @param WP_User $user The user object.
+ */
</ins><span class="cx"> // Must have ALL requested caps
</span><span class="cx"> $capabilities = apply_filters( 'user_has_cap', $this->allcaps, $caps, $args, $this );
</span><span class="cx"> $capabilities['exist'] = true; // Everyone is allowed to exist
</span><span class="lines">@@ -1170,6 +1201,21 @@
</span><span class="cx"> $meta_key = isset( $args[ 1 ] ) ? $args[ 1 ] : false;
</span><span class="cx">
</span><span class="cx"> if ( $meta_key && has_filter( "auth_post_meta_{$meta_key}" ) ) {
</span><ins>+ /**
+ * Filter whether the user is allowed to add post meta to a post.
+ *
+ * The dynamic portion of the hook name, $meta_key, refers to the
+ * meta key passed to map_meta_cap().
+ *
+ * @since 3.3.0
+ *
+ * @param bool $allowed Whether the user can add the post meta. Default false.
+ * @param string $meta_key The meta key.
+ * @param int $post_id Post ID.
+ * @param int $user_id User ID.
+ * @param string $cap Capability name.
+ * @param array $caps User capabilities.
+ */
</ins><span class="cx"> $allowed = apply_filters( "auth_post_meta_{$meta_key}", false, $meta_key, $post->ID, $user_id, $cap, $caps );
</span><span class="cx"> if ( ! $allowed )
</span><span class="cx"> $caps[] = $cap;
</span><span class="lines">@@ -1271,7 +1317,17 @@
</span><span class="cx"> $caps[] = $cap;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- return apply_filters('map_meta_cap', $caps, $cap, $user_id, $args);
</del><ins>+ /**
+ * Filter a user's capabilities depending on specific context and/or privilege.
+ *
+ * @since 2.8.0
+ *
+ * @param array $caps Returns the user's actual capabilities.
+ * @param string $cap Capability name.
+ * @param int $user_id The user ID.
+ * @param array $args Adds the context to the cap. Typically the object ID.
+ */
+ return apply_filters( 'map_meta_cap', $caps, $cap, $user_id, $args );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre>
</div>
</div>
</body>
</html>