<!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>[29455] trunk/src: Clean up some missing `@access` tags and other tweaks for 4.0.0-functionality docs.</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/29455">29455</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-08-09 19:31:35 +0000 (Sat, 09 Aug 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Clean up some missing `@access` tags and other tweaks for 4.0.0-functionality docs.
See <a href="http://core.trac.wordpress.org/ticket/28885">#28885</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpplugininstalllisttablephp">trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php</a></li>
<li><a href="#trunksrcwpincludesclasswpembedphp">trunk/src/wp-includes/class-wp-embed.php</a></li>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunksrcwpincludessessionphp">trunk/src/wp-includes/session.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpplugininstalllisttablephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php (29454 => 29455)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php 2014-08-09 19:29:37 UTC (rev 29454)
+++ trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php 2014-08-09 19:31:35 UTC (rev 29455)
</span><span class="lines">@@ -25,6 +25,7 @@
</span><span class="cx"> * within get_plugins().
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> */
</span><span class="cx"> protected function get_installed_plugin_slugs() {
</span><span class="cx"> $slugs = array();
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpembedphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-embed.php (29454 => 29455)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-embed.php 2014-08-09 19:29:37 UTC (rev 29454)
+++ trunk/src/wp-includes/class-wp-embed.php 2014-08-09 19:31:35 UTC (rev 29455)
</span><span class="lines">@@ -194,7 +194,7 @@
</span><span class="cx"> $cachekey_time = '_oembed_time_' . $key_suffix;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filter the oEmbed TTL (time to live).
</del><ins>+ * Filter the oEmbed TTL value (time to live).
</ins><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><span class="cx"> *
</span></span></pre></div>
<a id="trunksrcwpincludesmediaphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/media.php (29454 => 29455)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/media.php 2014-08-09 19:29:37 UTC (rev 29454)
+++ trunk/src/wp-includes/media.php 2014-08-09 19:31:35 UTC (rev 29455)
</span><span class="lines">@@ -2297,7 +2297,7 @@
</span><span class="cx"> * @since 4.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param array $matches The regex matches from the provided regex when calling
</span><del>- * {@link wp_embed_register_handler()}.
</del><ins>+ * {@see wp_embed_register_handler()}.
</ins><span class="cx"> * @param array $attr Embed attributes.
</span><span class="cx"> * @param string $url The original URL that was matched by the regex.
</span><span class="cx"> * @param array $rawattr The original unmodified attributes.
</span><span class="lines">@@ -3301,6 +3301,7 @@
</span><span class="cx"> * @since 4.0.0
</span><span class="cx"> *
</span><span class="cx"> * @global $wp_version
</span><ins>+ *
</ins><span class="cx"> * @return array The relevant CSS file URLs.
</span><span class="cx"> */
</span><span class="cx"> function wp_media_mce_styles() {
</span></span></pre></div>
<a id="trunksrcwpincludessessionphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/session.php (29454 => 29455)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/session.php 2014-08-09 19:29:37 UTC (rev 29454)
+++ trunk/src/wp-includes/session.php 2014-08-09 19:31:35 UTC (rev 29455)
</span><span class="lines">@@ -10,7 +10,7 @@
</span><span class="cx"> * User ID.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><del>- *
</del><ins>+ * @access protected
</ins><span class="cx"> * @var int User ID.
</span><span class="cx"> */
</span><span class="cx"> protected $user_id;
</span><span class="lines">@@ -31,6 +31,8 @@
</span><span class="cx"> * the session manager for a subclass of WP_Session_Tokens.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
+ * @static
</ins><span class="cx"> *
</span><span class="cx"> * @param int $user_id User whose session to manage.
</span><span class="cx"> */
</span><span class="lines">@@ -51,6 +53,7 @@
</span><span class="cx"> * Hashes a token for storage.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access private
</ins><span class="cx"> *
</span><span class="cx"> * @param string $token Token to hash.
</span><span class="cx"> * @return string A hash of the token (a verifier).
</span><span class="lines">@@ -65,6 +68,7 @@
</span><span class="cx"> * Checks that the given token is present and hasn't expired.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
</ins><span class="cx"> *
</span><span class="cx"> * @param string $token Token to verify.
</span><span class="cx"> * @return bool Whether the token is valid for the user.
</span><span class="lines">@@ -83,6 +87,7 @@
</span><span class="cx"> * with the associated expiration time.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
</ins><span class="cx"> *
</span><span class="cx"> * @param int $expiration Session expiration timestamp.
</span><span class="cx"> * @return string Session identification token.
</span><span class="lines">@@ -113,6 +118,7 @@
</span><span class="cx"> * Updates a session based on its token.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
</ins><span class="cx"> *
</span><span class="cx"> * @param string $token Token to update.
</span><span class="cx"> * @param array $session Session information.
</span><span class="lines">@@ -126,6 +132,7 @@
</span><span class="cx"> * Destroy a session token.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
</ins><span class="cx"> *
</span><span class="cx"> * @param string $token Token to destroy.
</span><span class="cx"> */
</span><span class="lines">@@ -139,6 +146,7 @@
</span><span class="cx"> * except a single token, presumably the one in use.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
</ins><span class="cx"> *
</span><span class="cx"> * @param string $token_to_keep Token to keep.
</span><span class="cx"> */
</span><span class="lines">@@ -157,6 +165,7 @@
</span><span class="cx"> * based on expiration.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><span class="cx"> * @param array $session Session to check.
</span><span class="cx"> * @return bool Whether session is valid.
</span><span class="lines">@@ -169,6 +178,7 @@
</span><span class="cx"> * Destroy all tokens for a user.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
</ins><span class="cx"> */
</span><span class="cx"> final public function destroy_all_tokens() {
</span><span class="cx"> $this->destroy_all_sessions();
</span><span class="lines">@@ -178,6 +188,8 @@
</span><span class="cx"> * Destroy all tokens for all users.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
+ * @static
</ins><span class="cx"> */
</span><span class="cx"> final public static function destroy_all_tokens_for_all_users() {
</span><span class="cx"> $manager = apply_filters( 'session_token_manager', 'WP_User_Meta_Session_Tokens' );
</span><span class="lines">@@ -188,6 +200,7 @@
</span><span class="cx"> * Retrieve all sessions of a user.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
</ins><span class="cx"> *
</span><span class="cx"> * @return array Sessions of a user.
</span><span class="cx"> */
</span><span class="lines">@@ -199,6 +212,7 @@
</span><span class="cx"> * This method should retrieve all sessions of a user, keyed by verifier.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><span class="cx"> * @return array Sessions of a user, keyed by verifier.
</span><span class="cx"> */
</span><span class="lines">@@ -208,6 +222,7 @@
</span><span class="cx"> * This method should look up a session by its verifier (token hash).
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><span class="cx"> * @param $verifier Verifier of the session to retrieve.
</span><span class="cx"> * @return array|null The session, or null if it does not exist.
</span><span class="lines">@@ -220,6 +235,7 @@
</span><span class="cx"> * Omitting the second argument should destroy the session.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><span class="cx"> * @param $verifier Verifier of the session to update.
</span><span class="cx"> */
</span><span class="lines">@@ -230,6 +246,7 @@
</span><span class="cx"> * except a single session passed.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><span class="cx"> * @param $verifier Verifier of the session to keep.
</span><span class="cx"> */
</span><span class="lines">@@ -239,6 +256,7 @@
</span><span class="cx"> * This method should destroy all sessions for a user.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> */
</span><span class="cx"> abstract protected function destroy_all_sessions();
</span><span class="cx">
</span><span class="lines">@@ -246,6 +264,8 @@
</span><span class="cx"> * This static method should destroy all session tokens for all users.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
+ * @static
</ins><span class="cx"> */
</span><span class="cx"> public static function drop_sessions() {}
</span><span class="cx"> }
</span><span class="lines">@@ -261,6 +281,7 @@
</span><span class="cx"> * Get all sessions of a user.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><span class="cx"> * @return array Sessions of a user.
</span><span class="cx"> */
</span><span class="lines">@@ -293,6 +314,7 @@
</span><span class="cx"> * Retrieve a session by its verifier (token hash).
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><span class="cx"> * @param $verifier Verifier of the session to retrieve.
</span><span class="cx"> * @return array|null The session, or null if it does not exist
</span><span class="lines">@@ -310,11 +332,11 @@
</span><span class="cx"> /**
</span><span class="cx"> * Update a session by its verifier.
</span><span class="cx"> *
</span><del>- * Omitting the second argument destroys the session.
- *
</del><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><del>- * @param $verifier Verifier of the session to update.
</del><ins>+ * @param string $verifier Verifier of the session to update.
+ * @param array $session Optional. Session. Omitting this argument destroys the session.
</ins><span class="cx"> */
</span><span class="cx"> protected function update_session( $verifier, $session = null ) {
</span><span class="cx"> $sessions = $this->get_sessions();
</span><span class="lines">@@ -332,8 +354,9 @@
</span><span class="cx"> * Update a user's sessions in the usermeta table.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><del>- * @param array $sessions
</del><ins>+ * @param array $sessions Sessions.
</ins><span class="cx"> */
</span><span class="cx"> protected function update_sessions( $sessions ) {
</span><span class="cx"> if ( ! has_filter( 'attach_session_information' ) ) {
</span><span class="lines">@@ -351,6 +374,7 @@
</span><span class="cx"> * Destroy all session tokens for a user, except a single session passed.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> *
</span><span class="cx"> * @param $verifier Verifier of the session to keep.
</span><span class="cx"> */
</span><span class="lines">@@ -363,6 +387,7 @@
</span><span class="cx"> * Destroy all session tokens for a user.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access protected
</ins><span class="cx"> */
</span><span class="cx"> protected function destroy_all_sessions() {
</span><span class="cx"> $this->update_sessions( array() );
</span><span class="lines">@@ -372,6 +397,8 @@
</span><span class="cx"> * Destroy all session tokens for all users.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
+ * @static
</ins><span class="cx"> */
</span><span class="cx"> public static function drop_sessions() {
</span><span class="cx"> delete_metadata( 'user', false, 'session_tokens', false, true );
</span></span></pre>
</div>
</div>
</body>
</html>