<!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" /><style type="text/css"><!--

#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }

#msg dt { float: left; width: 6em; font-weight: bold; }

#msg dt:after { content:':';}

#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { 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 #fc0 solid; padding: 6px; }

#msg ul, pre { overflow: auto; }

#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>

<title>[12160] trunk/wp-includes/capabilities.php:

  Better documentation on the format of the capabilities when adding a role.</title>

</head>

<body>

<div id="msg">

<dl>

<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/12160">12160</a></dd>

<dt>Author</dt> <dd>westi</dd>

<dt>Date</dt> <dd>2009-11-09 22:15:50 +0000 (Mon, 09 Nov 2009)</dd>

</dl>

<h3>Log Message</h3>

<pre>Better documentation on the format of the capabilities when adding a role. Fixes <a href="http://trac.wordpress.org/ticket/11106">#11106</a> props simonwheatley.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunkwpincludescapabilitiesphp">trunk/wp-includes/capabilities.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunkwpincludescapabilitiesphp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/capabilities.php (12159 => 12160)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/capabilities.php        2009-11-09 21:54:52 UTC (rev 12159)

+++ trunk/wp-includes/capabilities.php        2009-11-09 22:15:50 UTC (rev 12160)

</span><span class="lines">@@ -123,12 +123,15 @@

</span><span class="cx">          *

<span class="cx">          * Updates the list of roles, if the role doesn't already exist.

</span><span class="cx">          *

</span><ins>+         * The capabilities are defined in the following format `array( 'read' =&gt; true );`

+         * To explicitly deny a role a capability you set the value for that capability to false.

+         * 

</ins><span class="cx">          * @since 2.0.0

</span><span class="cx">          * @access public

</span><span class="cx">          *

<span class="cx">          * @param string $role Role name.

<span class="cx">          * @param string $display_name Role display name.

<del>-         * @param array $capabilities List of role capabilities.

</del><ins>+         * @param array $capabilities List of role capabilities in the above format.

</ins><span class="cx">          * @return null|WP_Role WP_Role object if role is added, null if already exists.

</span><span class="cx">          */

</span><span class="cx">         function add_role( $role, $display_name, $capabilities = array() ) {

</span><span class="lines">@@ -174,7 +177,7 @@

</span><span class="cx">          *

<span class="cx">          * @param string $role Role name.

<span class="cx">          * @param string $cap Capability name.

<del>-         * @param bool $grant Optional, default is true. Whether role is capable of preforming capability.

</del><ins>+         * @param bool $grant Optional, default is true. Whether role is capable of performing capability.

</ins><span class="cx">          */

</span><span class="cx">         function add_cap( $role, $cap, $grant = true ) {

</span><span class="cx">                 $this-&gt;roles[$role]['capabilities'][$cap] = $grant;

</span></span></pre>

</div>

</div>

</body>

</html>