Clean up some missing `@access` tags and other tweaks for 4.0.0-functionality docs.

See #28885.

Built from https://develop.svn.wordpress.org/trunk@29455


git-svn-id: http://core.svn.wordpress.org/trunk@29233 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-08-09 19:32:16 +00:00
parent a8583d5f19
commit 647b6d907b
4 changed files with 36 additions and 7 deletions

View File

@ -25,6 +25,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
* within get_plugins(). * within get_plugins().
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
*/ */
protected function get_installed_plugin_slugs() { protected function get_installed_plugin_slugs() {
$slugs = array(); $slugs = array();

View File

@ -194,7 +194,7 @@ class WP_Embed {
$cachekey_time = '_oembed_time_' . $key_suffix; $cachekey_time = '_oembed_time_' . $key_suffix;
/** /**
* Filter the oEmbed TTL (time to live). * Filter the oEmbed TTL value (time to live).
* *
* @since 4.0.0 * @since 4.0.0
* *

View File

@ -2297,7 +2297,7 @@ function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
* @since 4.0.0 * @since 4.0.0
* *
* @param array $matches The regex matches from the provided regex when calling * @param array $matches The regex matches from the provided regex when calling
* {@link wp_embed_register_handler()}. * {@see wp_embed_register_handler()}.
* @param array $attr Embed attributes. * @param array $attr Embed attributes.
* @param string $url The original URL that was matched by the regex. * @param string $url The original URL that was matched by the regex.
* @param array $rawattr The original unmodified attributes. * @param array $rawattr The original unmodified attributes.
@ -3301,6 +3301,7 @@ function attachment_url_to_postid( $url ) {
* @since 4.0.0 * @since 4.0.0
* *
* @global $wp_version * @global $wp_version
*
* @return array The relevant CSS file URLs. * @return array The relevant CSS file URLs.
*/ */
function wp_media_mce_styles() { function wp_media_mce_styles() {

View File

@ -10,7 +10,7 @@ abstract class WP_Session_Tokens {
* User ID. * User ID.
* *
* @since 4.0.0 * @since 4.0.0
* * @access protected
* @var int User ID. * @var int User ID.
*/ */
protected $user_id; protected $user_id;
@ -31,6 +31,8 @@ abstract class WP_Session_Tokens {
* the session manager for a subclass of WP_Session_Tokens. * the session manager for a subclass of WP_Session_Tokens.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* @static
* *
* @param int $user_id User whose session to manage. * @param int $user_id User whose session to manage.
*/ */
@ -51,6 +53,7 @@ abstract class WP_Session_Tokens {
* Hashes a token for storage. * Hashes a token for storage.
* *
* @since 4.0.0 * @since 4.0.0
* @access private
* *
* @param string $token Token to hash. * @param string $token Token to hash.
* @return string A hash of the token (a verifier). * @return string A hash of the token (a verifier).
@ -65,6 +68,7 @@ abstract class WP_Session_Tokens {
* Checks that the given token is present and hasn't expired. * Checks that the given token is present and hasn't expired.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @param string $token Token to verify. * @param string $token Token to verify.
* @return bool Whether the token is valid for the user. * @return bool Whether the token is valid for the user.
@ -83,6 +87,7 @@ abstract class WP_Session_Tokens {
* with the associated expiration time. * with the associated expiration time.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @param int $expiration Session expiration timestamp. * @param int $expiration Session expiration timestamp.
* @return string Session identification token. * @return string Session identification token.
@ -113,6 +118,7 @@ abstract class WP_Session_Tokens {
* Updates a session based on its token. * Updates a session based on its token.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @param string $token Token to update. * @param string $token Token to update.
* @param array $session Session information. * @param array $session Session information.
@ -126,6 +132,7 @@ abstract class WP_Session_Tokens {
* Destroy a session token. * Destroy a session token.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @param string $token Token to destroy. * @param string $token Token to destroy.
*/ */
@ -139,6 +146,7 @@ abstract class WP_Session_Tokens {
* except a single token, presumably the one in use. * except a single token, presumably the one in use.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @param string $token_to_keep Token to keep. * @param string $token_to_keep Token to keep.
*/ */
@ -157,6 +165,7 @@ abstract class WP_Session_Tokens {
* based on expiration. * based on expiration.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @param array $session Session to check. * @param array $session Session to check.
* @return bool Whether session is valid. * @return bool Whether session is valid.
@ -169,6 +178,7 @@ abstract class WP_Session_Tokens {
* Destroy all tokens for a user. * Destroy all tokens for a user.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
*/ */
final public function destroy_all_tokens() { final public function destroy_all_tokens() {
$this->destroy_all_sessions(); $this->destroy_all_sessions();
@ -178,6 +188,8 @@ abstract class WP_Session_Tokens {
* Destroy all tokens for all users. * Destroy all tokens for all users.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* @static
*/ */
final public static function destroy_all_tokens_for_all_users() { final public static function destroy_all_tokens_for_all_users() {
$manager = apply_filters( 'session_token_manager', 'WP_User_Meta_Session_Tokens' ); $manager = apply_filters( 'session_token_manager', 'WP_User_Meta_Session_Tokens' );
@ -188,6 +200,7 @@ abstract class WP_Session_Tokens {
* Retrieve all sessions of a user. * Retrieve all sessions of a user.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @return array Sessions of a user. * @return array Sessions of a user.
*/ */
@ -199,6 +212,7 @@ abstract class WP_Session_Tokens {
* This method should retrieve all sessions of a user, keyed by verifier. * This method should retrieve all sessions of a user, keyed by verifier.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @return array Sessions of a user, keyed by verifier. * @return array Sessions of a user, keyed by verifier.
*/ */
@ -208,6 +222,7 @@ abstract class WP_Session_Tokens {
* This method should look up a session by its verifier (token hash). * This method should look up a session by its verifier (token hash).
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @param $verifier Verifier of the session to retrieve. * @param $verifier Verifier of the session to retrieve.
* @return array|null The session, or null if it does not exist. * @return array|null The session, or null if it does not exist.
@ -220,6 +235,7 @@ abstract class WP_Session_Tokens {
* Omitting the second argument should destroy the session. * Omitting the second argument should destroy the session.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @param $verifier Verifier of the session to update. * @param $verifier Verifier of the session to update.
*/ */
@ -230,6 +246,7 @@ abstract class WP_Session_Tokens {
* except a single session passed. * except a single session passed.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @param $verifier Verifier of the session to keep. * @param $verifier Verifier of the session to keep.
*/ */
@ -239,6 +256,7 @@ abstract class WP_Session_Tokens {
* This method should destroy all sessions for a user. * This method should destroy all sessions for a user.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
*/ */
abstract protected function destroy_all_sessions(); abstract protected function destroy_all_sessions();
@ -246,6 +264,8 @@ abstract class WP_Session_Tokens {
* This static method should destroy all session tokens for all users. * This static method should destroy all session tokens for all users.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* @static
*/ */
public static function drop_sessions() {} public static function drop_sessions() {}
} }
@ -261,6 +281,7 @@ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
* Get all sessions of a user. * Get all sessions of a user.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @return array Sessions of a user. * @return array Sessions of a user.
*/ */
@ -293,6 +314,7 @@ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
* Retrieve a session by its verifier (token hash). * Retrieve a session by its verifier (token hash).
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @param $verifier Verifier of the session to retrieve. * @param $verifier Verifier of the session to retrieve.
* @return array|null The session, or null if it does not exist * @return array|null The session, or null if it does not exist
@ -310,11 +332,11 @@ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
/** /**
* Update a session by its verifier. * Update a session by its verifier.
* *
* Omitting the second argument destroys the session.
*
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @param $verifier Verifier of the session to update. * @param string $verifier Verifier of the session to update.
* @param array $session Optional. Session. Omitting this argument destroys the session.
*/ */
protected function update_session( $verifier, $session = null ) { protected function update_session( $verifier, $session = null ) {
$sessions = $this->get_sessions(); $sessions = $this->get_sessions();
@ -332,8 +354,9 @@ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
* Update a user's sessions in the usermeta table. * Update a user's sessions in the usermeta table.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @param array $sessions * @param array $sessions Sessions.
*/ */
protected function update_sessions( $sessions ) { protected function update_sessions( $sessions ) {
if ( ! has_filter( 'attach_session_information' ) ) { if ( ! has_filter( 'attach_session_information' ) ) {
@ -351,6 +374,7 @@ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
* Destroy all session tokens for a user, except a single session passed. * Destroy all session tokens for a user, except a single session passed.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
* *
* @param $verifier Verifier of the session to keep. * @param $verifier Verifier of the session to keep.
*/ */
@ -363,6 +387,7 @@ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
* Destroy all session tokens for a user. * Destroy all session tokens for a user.
* *
* @since 4.0.0 * @since 4.0.0
* @access protected
*/ */
protected function destroy_all_sessions() { protected function destroy_all_sessions() {
$this->update_sessions( array() ); $this->update_sessions( array() );
@ -372,6 +397,8 @@ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
* Destroy all session tokens for all users. * Destroy all session tokens for all users.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* @static
*/ */
public static function drop_sessions() { public static function drop_sessions() {
delete_metadata( 'user', false, 'session_tokens', false, true ); delete_metadata( 'user', false, 'session_tokens', false, true );