vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Browse Source 
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2017-07-27 00:40:27 +00:00
parent 829139ba1a
commit b4d81bd654
135 changed files with 2 additions and 1906 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
src/wp-includes/wp-db.php
View File

@@ -56,7 +56,6 @@ class wpdb {
* evaluated to true.
*
* @since 0.71
* @access private
* @var bool
*/
var $show_errors = false;
@@ -64,7 +63,6 @@ class wpdb {
/**
* Whether to suppress errors during the DB bootstrapping.
*
* @access private
* @since 2.5.0
* @var bool
*/
@@ -82,7 +80,6 @@ class wpdb {
* Amount of queries made
*
* @since 1.2.0
* @access public
* @var int
*/
public $num_queries = 0;
@@ -91,7 +88,6 @@ class wpdb {
* Count of rows returned by previous query
*
* @since 0.71
* @access public
* @var int
*/
public $num_rows = 0;
@@ -100,7 +96,6 @@ class wpdb {
* Count of affected rows by previous query
*
* @since 0.71
* @access private
* @var int
*/
var $rows_affected = 0;
@@ -109,7 +104,6 @@ class wpdb {
* The ID generated for an AUTO_INCREMENT column by the previous query (usually INSERT).
*
* @since 0.71
* @access public
* @var int
*/
public $insert_id = 0;
@@ -118,7 +112,6 @@ class wpdb {
* Last query made
*
* @since 0.71
* @access private
* @var array
*/
var $last_query;
@@ -127,7 +120,6 @@ class wpdb {
* Results of the last query made
*
* @since 0.71
* @access private
* @var array|null
*/
var $last_result;
@@ -136,7 +128,6 @@ class wpdb {
* MySQL result, which is either a resource or boolean.
*
* @since 0.71
* @access protected
* @var mixed
*/
protected $result;
@@ -145,7 +136,6 @@ class wpdb {
* Cached column info, for sanity checking data before inserting
*
* @since 4.2.0
* @access protected
* @var array
*/
protected $col_meta = array();
@@ -154,7 +144,6 @@ class wpdb {
* Calculated character sets on tables
*
* @since 4.2.0
* @access protected
* @var array
*/
protected $table_charset = array();
@@ -163,7 +152,6 @@ class wpdb {
* Whether text fields in the current query need to be sanity checked.
*
* @since 4.2.0
* @access protected
* @var bool
*/
protected $check_current_query = true;
@@ -172,7 +160,6 @@ class wpdb {
* Flag to ensure we don't run into recursion problems when checking the collation.
*
* @since 4.2.0
* @access private
* @see wpdb::check_safe_collation()
* @var bool
*/
@@ -182,7 +169,6 @@ class wpdb {
* Saved info on the table column
*
* @since 0.71
* @access protected
* @var array
*/
protected $col_info;
@@ -191,7 +177,6 @@ class wpdb {
* Saved queries that were executed
*
* @since 1.5.0
* @access private
* @var array
*/
var $queries;
@@ -200,7 +185,6 @@ class wpdb {
* The number of times to retry reconnecting before dying.
*
* @since 3.9.0
* @access protected
* @see wpdb::check_connection()
* @var int
*/
@@ -214,7 +198,6 @@ class wpdb {
* security precautions.
*
* @since 2.5.0
* @access public
* @var string
*/
public $prefix = '';
@@ -223,7 +206,6 @@ class wpdb {
* WordPress base table prefix.
*
* @since 3.0.0
* @access public
* @var string
*/
public $base_prefix;
@@ -232,7 +214,6 @@ class wpdb {
* Whether the database queries are ready to start executing.
*
* @since 2.3.2
* @access private
* @var bool
*/
var $ready = false;
@@ -241,7 +222,6 @@ class wpdb {
* Blog ID.
*
* @since 3.0.0
* @access public
* @var int
*/
public $blogid = 0;
@@ -250,7 +230,6 @@ class wpdb {
* Site ID.
*
* @since 3.0.0
* @access public
* @var int
*/
public $siteid = 0;
@@ -259,7 +238,6 @@ class wpdb {
* List of WordPress per-blog tables
*
* @since 2.5.0
* @access private
* @see wpdb::tables()
* @var array
*/
@@ -272,7 +250,6 @@ class wpdb {
* categories, post2cat, and link2cat were deprecated in 2.3.0, db version 5539
*
* @since 2.9.0
* @access private
* @see wpdb::tables()
* @var array
*/
@@ -282,7 +259,6 @@ class wpdb {
* List of WordPress global tables
*
* @since 3.0.0
* @access private
* @see wpdb::tables()
* @var array
*/
@@ -292,7 +268,6 @@ class wpdb {
* List of Multisite global tables
*
* @since 3.0.0
* @access private
* @see wpdb::tables()
* @var array
*/
@@ -303,7 +278,6 @@ class wpdb {
* WordPress Comments table
*
* @since 1.5.0
* @access public
* @var string
*/
public $comments;
@@ -312,7 +286,6 @@ class wpdb {
* WordPress Comment Metadata table
*
* @since 2.9.0
* @access public
* @var string
*/
public $commentmeta;
@@ -321,7 +294,6 @@ class wpdb {
* WordPress Links table
*
* @since 1.5.0
* @access public
* @var string
*/
public $links;
@@ -330,7 +302,6 @@ class wpdb {
* WordPress Options table
*
* @since 1.5.0
* @access public
* @var string
*/
public $options;
@@ -339,7 +310,6 @@ class wpdb {
* WordPress Post Metadata table
*
* @since 1.5.0
* @access public
* @var string
*/
public $postmeta;
@@ -348,7 +318,6 @@ class wpdb {
* WordPress Posts table
*
* @since 1.5.0
* @access public
* @var string
*/
public $posts;
@@ -357,7 +326,6 @@ class wpdb {
* WordPress Terms table
*
* @since 2.3.0
* @access public
* @var string
*/
public $terms;
@@ -366,7 +334,6 @@ class wpdb {
* WordPress Term Relationships table
*
* @since 2.3.0
* @access public
* @var string
*/
public $term_relationships;
@@ -375,7 +342,6 @@ class wpdb {
* WordPress Term Taxonomy table
*
* @since 2.3.0
* @access public
* @var string
*/
public $term_taxonomy;
@@ -384,7 +350,6 @@ class wpdb {
* WordPress Term Meta table.
*
* @since 4.4.0
* @access public
* @var string
*/
public $termmeta;
@@ -397,7 +362,6 @@ class wpdb {
* WordPress User Metadata table
*
* @since 2.3.0
* @access public
* @var string
*/
public $usermeta;
@@ -406,7 +370,6 @@ class wpdb {
* WordPress Users table
*
* @since 1.5.0
* @access public
* @var string
*/
public $users;
@@ -415,7 +378,6 @@ class wpdb {
* Multisite Blogs table
*
* @since 3.0.0
* @access public
* @var string
*/
public $blogs;
@@ -424,7 +386,6 @@ class wpdb {
* Multisite Blog Versions table
*
* @since 3.0.0
* @access public
* @var string
*/
public $blog_versions;
@@ -433,7 +394,6 @@ class wpdb {
* Multisite Registration Log table
*
* @since 3.0.0
* @access public
* @var string
*/
public $registration_log;
@@ -442,7 +402,6 @@ class wpdb {
* Multisite Signups table
*
* @since 3.0.0
* @access public
* @var string
*/
public $signups;
@@ -451,7 +410,6 @@ class wpdb {
* Multisite Sites table
*
* @since 3.0.0
* @access public
* @var string
*/
public $site;
@@ -460,7 +418,6 @@ class wpdb {
* Multisite Sitewide Terms table
*
* @since 3.0.0
* @access public
* @var string
*/
public $sitecategories;
@@ -469,7 +426,6 @@ class wpdb {
* Multisite Site Metadata table
*
* @since 3.0.0
* @access public
* @var string
*/
public $sitemeta;
@@ -485,7 +441,6 @@ class wpdb {
* @see wpdb::update()
* @see wpdb::delete()
* @see wp_set_wpdb_vars()
* @access public
* @var array
*/
public $field_types = array();
@@ -494,7 +449,6 @@ class wpdb {
* Database table columns charset
*
* @since 2.2.0
* @access public
* @var string
*/
public $charset;
@@ -503,7 +457,6 @@ class wpdb {
* Database table columns collate
*
* @since 2.2.0
* @access public
* @var string
*/
public $collate;
@@ -512,7 +465,6 @@ class wpdb {
* Database Username
*
* @since 2.9.0
* @access protected
* @var string
*/
protected $dbuser;
@@ -521,7 +473,6 @@ class wpdb {
* Database Password
*
* @since 3.1.0
* @access protected
* @var string
*/
protected $dbpassword;
@@ -530,7 +481,6 @@ class wpdb {
* Database Name
*
* @since 3.1.0
* @access protected
* @var string
*/
protected $dbname;
@@ -539,7 +489,6 @@ class wpdb {
* Database Host
*
* @since 3.1.0
* @access protected
* @var string
*/
protected $dbhost;
@@ -548,7 +497,6 @@ class wpdb {
* Database Handle
*
* @since 0.71
* @access protected
* @var string
*/
protected $dbh;
@@ -557,7 +505,6 @@ class wpdb {
* A textual description of the last query/get_row/get_var call
*
* @since 3.0.0
* @access public
* @var string
*/
public $func_call;
@@ -571,7 +518,6 @@ class wpdb {
* will force the checks to occur.
*
* @since 3.3.0
* @access public
* @var bool
*/
public $is_mysql = null;
@@ -580,7 +526,6 @@ class wpdb {
* A list of incompatible SQL modes.
*
* @since 3.9.0
* @access protected
* @var array
*/
protected $incompatible_modes = array( 'NO_ZERO_DATE', 'ONLY_FULL_GROUP_BY',
@@ -590,7 +535,6 @@ class wpdb {
* Whether to use mysqli over mysql.
*
* @since 3.9.0
* @access private
* @var bool
*/
private $use_mysqli = false;
@@ -599,7 +543,6 @@ class wpdb {
* Whether we've managed to successfully connect at some point
*
* @since 3.9.0
* @access private
* @var bool
*/
private $has_connected = false;
@@ -762,7 +705,6 @@ class wpdb {
* For example, when able, utf8mb4 should be used instead of utf8.
*
* @since 4.6.0
* @access public
*
* @param string $charset The character set to check.
* @param string $collate The collation to check.
@@ -949,7 +891,6 @@ class wpdb {
* Sets blog id.
*
* @since 3.0.0
* @access public
*
* @param int $blog_id
* @param int $site_id Optional.
@@ -1141,7 +1082,6 @@ class wpdb {
* @deprecated 3.6.0 Use wpdb::prepare()
* @see wpdb::prepare
* @see esc_sql()
* @access private
*
* @param string $string
* @return string
@@ -1158,7 +1098,6 @@ class wpdb {
* @see mysqli_real_escape_string()
* @see mysql_real_escape_string()
* @since 2.8.0
* @access private
*
* @param string $string to escape
* @return string escaped
@@ -1187,7 +1126,6 @@ class wpdb {
*
* @uses wpdb::_real_escape()
* @since 2.8.0
* @access public
*
* @param string|array $data
* @return string|array escaped
@@ -1325,7 +1263,6 @@ class wpdb {
* $sql = esc_sql( $wpdb->esc_like( $input ) );
*
* @since 4.0.0
* @access public
*
* @param string $text The raw text to be escaped. The input typed by the user should have no
* extra or deleted slashes.
@@ -1861,7 +1798,6 @@ class wpdb {
*
* @since 3.9.0
*
* @access private
* @see wpdb::query()
*
* @param string $query The query to run.
@@ -1938,7 +1874,6 @@ class wpdb {
*
* Runs an insert or replace query based on $type argument.
*
* @access private
* @since 3.0.0
* @see wpdb::prepare()
* @see wpdb::$field_types
@@ -2121,7 +2056,6 @@ class wpdb {
* stripped, then field processing is rejected and the query fails.
*
* @since 4.2.0
* @access protected
*
* @param string $table Table name.
* @param array $data Field/value pair.
@@ -2158,7 +2092,6 @@ class wpdb {
* Prepares arrays of value/format pairs as passed to wpdb CRUD methods.
*
* @since 4.2.0
* @access protected
*
* @param array $data Array of fields to values.
* @param mixed $format Formats to be mapped to the values in $data.
@@ -2194,7 +2127,6 @@ class wpdb {
* the wpdb::process_field_formats() method.
*
* @since 4.2.0
* @access protected
*
* @param array $data As it comes from the wpdb::process_field_formats() method.
* @param string $table Table name.
@@ -2225,7 +2157,6 @@ class wpdb {
* For string fields, record the maximum string length that field can safely save.
*
* @since 4.2.1
* @access protected
*
* @param array $data As it comes from the wpdb::process_field_charsets() method.
* @param string $table Table name.
@@ -2427,7 +2358,6 @@ class wpdb {
* Retrieves the character set for the given table.
*
* @since 4.2.0
* @access protected
*
* @param string $table Table name.
* @return string|WP_Error Table character set, WP_Error object if it couldn't be found.
@@ -2528,7 +2458,6 @@ class wpdb {
* Retrieves the character set for the given column.
*
* @since 4.2.0
* @access public
*
* @param string $table Table name.
* @param string $column Column name.
@@ -2593,7 +2522,6 @@ class wpdb {
* The length may either be specified as a byte length or a character length.
*
* @since 4.2.1
* @access public
*
* @param string $table Table name.
* @param string $column Column name.
@@ -2686,7 +2614,6 @@ class wpdb {
* the search to finish as soon as it encounters a non-ASCII character.
*
* @since 4.2.0
* @access protected
*
* @param string $string String to check.
* @return bool True if ASCII, false if not.
@@ -2707,7 +2634,6 @@ class wpdb {
* Check if the query is accessing a collation considered safe on the current version of MySQL.
*
* @since 4.2.0
* @access protected
*
* @param string $query The query to check.
* @return bool True if the collation is safe, false if it isn't.
@@ -2765,7 +2691,6 @@ class wpdb {
* Strips any invalid characters based on value/charset pairs.
*
* @since 4.2.0
* @access protected
*
* @param array $data Array of value arrays. Each value array has the keys
* 'value' and 'charset'. An optional 'ascii' key can be
@@ -2925,7 +2850,6 @@ class wpdb {
* Strips any invalid characters from the query.
*
* @since 4.2.0
* @access protected
*
* @param string $query Query to convert.
* @return string|WP_Error The converted query, or a WP_Error object if the conversion fails.
@@ -2971,7 +2895,6 @@ class wpdb {
* Strips any invalid characters from the string for a given table and column.
*
* @since 4.2.0
* @access public
*
* @param string $table Table name.
* @param string $column Column name.
@@ -3012,7 +2935,6 @@ class wpdb {
* Find the first table name referenced in a query.
*
* @since 4.2.0
* @access protected
*
* @param string $query The query to search.
* @return string|false $table The table name found, or false if a table couldn't be found.
@@ -3079,7 +3001,6 @@ class wpdb {
*
* @since 3.5.0
*
* @access protected
*/
protected function load_col_info() {
if ( $this->col_info )
@@ -3176,7 +3097,6 @@ class wpdb {
* Closes the current database connection.
*
* @since 4.5.0
* @access public
*
* @return bool True if the connection was successfully closed, false if it wasn't,
* or the connection doesn't exist.