vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-12 12:50:28 +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
src/wp-includes/class-wp-rewrite.php
-63
View File
@@ -43,7 +43,6 @@ class WP_Rewrite {
* Base for the author permalink structure (example.com/$author_base/authorname).
*
* @since 1.5.0
* @access private
* @var string
*/
var $author_base = 'author';
@@ -52,7 +51,6 @@ class WP_Rewrite {
* Permalink structure for author archives.
*
* @since 1.5.0
* @access private
* @var string
*/
var $author_structure;
@@ -61,7 +59,6 @@ class WP_Rewrite {
* Permalink structure for date archives.
*
* @since 1.5.0
* @access private
* @var string
*/
var $date_structure;
@@ -70,7 +67,6 @@ class WP_Rewrite {
* Permalink structure for pages.
*
* @since 1.5.0
* @access private
* @var string
*/
var $page_structure;
@@ -79,7 +75,6 @@ class WP_Rewrite {
* Base of the search permalink structure (example.com/$search_base/query).
*
* @since 1.5.0
* @access private
* @var string
*/
var $search_base = 'search';
@@ -88,7 +83,6 @@ class WP_Rewrite {
* Permalink structure for searches.
*
* @since 1.5.0
* @access private
* @var string
*/
var $search_structure;
@@ -97,7 +91,6 @@ class WP_Rewrite {
* Comments permalink base.
*
* @since 1.5.0
* @access private
* @var string
*/
var $comments_base = 'comments';
@@ -114,7 +107,6 @@ class WP_Rewrite {
* Comments pagination permalink base.
*
* @since 4.2.0
* @access private
* @var string
*/
var $comments_pagination_base = 'comment-page';
@@ -123,7 +115,6 @@ class WP_Rewrite {
* Feed permalink base.
*
* @since 1.5.0
* @access private
* @var string
*/
var $feed_base = 'feed';
@@ -132,7 +123,6 @@ class WP_Rewrite {
* Comments feed permalink structure.
*
* @since 1.5.0
* @access private
* @var string
*/
var $comment_feed_structure;
@@ -141,7 +131,6 @@ class WP_Rewrite {
* Feed request permalink structure.
*
* @since 1.5.0
* @access private
* @var string
*/
var $feed_structure;
@@ -154,7 +143,6 @@ class WP_Rewrite {
* then the front is "/".
*
* @since 1.5.0
* @access public
* @var string
*
* @see WP_Rewrite::init()
@@ -169,7 +157,6 @@ class WP_Rewrite {
* will be empty.
*
* @since 1.5.0
* @access public
* @var string
*
* @see WP_Rewrite::init()
@@ -181,7 +168,6 @@ class WP_Rewrite {
* The name of the index file which is the entry point to all requests.
*
* @since 1.5.0
* @access public
* @var string
*/
public $index = 'index.php';
@@ -190,7 +176,6 @@ class WP_Rewrite {
* Variable name to use for regex matches in the rewritten query.
*
* @since 1.5.0
* @access private
* @var string
*/
var $matches = '';
@@ -199,7 +184,6 @@ class WP_Rewrite {
* Rewrite rules to match against the request to find the redirect or query.
*
* @since 1.5.0
* @access private
* @var array
*/
var $rules;
@@ -210,7 +194,6 @@ class WP_Rewrite {
* Those not generated by the class, see add_rewrite_rule().
*
* @since 2.1.0
* @access private
* @var array
*/
var $extra_rules = array();
@@ -221,7 +204,6 @@ class WP_Rewrite {
* Those not generated by the class, see add_rewrite_rule().
*
* @since 2.3.0
* @access private
* @var array
*/
var $extra_rules_top = array();
@@ -233,7 +215,6 @@ class WP_Rewrite {
* and are added by add_external_rule().
*
* @since 2.1.0
* @access private
* @var array
*/
var $non_wp_rules = array();
@@ -242,7 +223,6 @@ class WP_Rewrite {
* Extra permalink structures, e.g. categories, added by add_permastruct().
*
* @since 2.1.0
* @access private
* @var array
*/
var $extra_permastructs = array();
@@ -251,7 +231,6 @@ class WP_Rewrite {
* Endpoints (like /trackback/) added by add_rewrite_endpoint().
*
* @since 2.1.0
* @access private
* @var array
*/
var $endpoints;
@@ -263,7 +242,6 @@ class WP_Rewrite {
* to the .htaccess file.
*
* @since 2.0.0
* @access public
* @var bool
*
* @see WP_Rewrite::mod_rewrite_rules()
@@ -281,7 +259,6 @@ class WP_Rewrite {
* permastruct is actually a page before accepting it.
*
* @since 2.5.0
* @access public
* @var bool
*
* @see WP_Rewrite::init()
@@ -298,7 +275,6 @@ class WP_Rewrite {
* Additional tags can be added with add_rewrite_tag().
*
* @since 1.5.0
* @access private
* @var array
*/
var $rewritecode = array(
@@ -320,7 +296,6 @@ class WP_Rewrite {
* of rewrite tags, see WP_Rewrite::$rewritecode.
*
* @since 1.5.0
* @access private
* @var array
*/
var $rewritereplace = array(
@@ -341,7 +316,6 @@ class WP_Rewrite {
* Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode.
*
* @since 1.5.0
* @access private
* @var array
*/
var $queryreplace = array(
@@ -372,7 +346,6 @@ class WP_Rewrite {
* This can be either rewrite module or permalink in the HTTP query string.
*
* @since 1.5.0
* @access public
*
* @return bool True, if permalinks are enabled.
*/
@@ -386,7 +359,6 @@ class WP_Rewrite {
* Means that permalink links are enabled and index.php is in the URL.
*
* @since 1.5.0
* @access public
*
* @return bool Whether permalink links are enabled and index.php is in the URL.
*/
@@ -405,7 +377,6 @@ class WP_Rewrite {
* Using permalinks and index.php is not in the URL.
*
* @since 1.5.0
* @access public
*
* @return bool Whether permalink links are enabled and index.php is NOT in the URL.
*/
@@ -424,7 +395,6 @@ class WP_Rewrite {
* value of the $number parameter.
*
* @since 1.5.0
* @access public
*
* @param int $number Index number.
* @return string
@@ -448,7 +418,6 @@ class WP_Rewrite {
* retrieved.
*
* @since 2.5.0
* @access public
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -492,7 +461,6 @@ class WP_Rewrite {
* Retrieves all of the rewrite rules for pages.
*
* @since 1.5.0
* @access public
*
* @return array Page rewrite rules.
*/
@@ -519,7 +487,6 @@ class WP_Rewrite {
* structure.
*
* @since 1.5.0
* @access public
*
* @return string|false False on no permalink structure. Date permalink structure.
*/
@@ -575,7 +542,6 @@ class WP_Rewrite {
* permalink structures.
*
* @since 1.5.0
* @access public
*
* @return false|string False on failure. Year structure on success.
*/
@@ -599,7 +565,6 @@ class WP_Rewrite {
* structures. Keeps the year permalink structure.
*
* @since 1.5.0
* @access public
*
* @return false|string False on failure. Year/Month structure on success.
*/
@@ -621,7 +586,6 @@ class WP_Rewrite {
* Keeps date permalink structure with all year, month, and day.
*
* @since 1.5.0
* @access public
*
* @return string|false False on failure. Year/Month/Day structure on success.
*/
@@ -638,7 +602,6 @@ class WP_Rewrite {
* the category_base property value.
*
* @since 1.5.0
* @access public
*
* @return string|false False on failure. Category permalink structure.
*/
@@ -655,7 +618,6 @@ class WP_Rewrite {
* property value.
*
* @since 2.3.0
* @access public
*
* @return string|false False on failure. Tag permalink structure.
*/
@@ -667,7 +629,6 @@ class WP_Rewrite {
* Retrieves an extra permalink structure by name.
*
* @since 2.5.0
* @access public
*
* @param string $name Permalink structure name.
* @return string|false False if not found. Permalink structure string.
@@ -690,7 +651,6 @@ class WP_Rewrite {
* without attempting to set the value again.
*
* @since 1.5.0
* @access public
*
* @return string|false False if not found. Permalink structure string.
*/
@@ -716,7 +676,6 @@ class WP_Rewrite {
* without attempting to set the value again.
*
* @since 1.5.0
* @access public
*
* @return string|false False if not found. Permalink structure string.
*/
@@ -742,7 +701,6 @@ class WP_Rewrite {
* value again.
*
* @since 1.5.0
* @access public
*
* @return string|false False if not found. Permalink structure string.
*/
@@ -768,7 +726,6 @@ class WP_Rewrite {
* without attempting to set the value again.
*
* @since 1.5.0
* @access public
*
* @return string|false False if not found. Permalink structure string.
*/
@@ -794,7 +751,6 @@ class WP_Rewrite {
* and then return it without attempting to set the value again.
*
* @since 1.5.0
* @access public
*
* @return string|false False if not found. Permalink structure string.
*/
@@ -819,7 +775,6 @@ class WP_Rewrite {
* that tag, otherwise add the new tag.
*
* @since 1.5.0
* @access public
*
* @see WP_Rewrite::$rewritecode
* @see WP_Rewrite::$rewritereplace
@@ -846,7 +801,6 @@ class WP_Rewrite {
* Removes an existing rewrite tag.
*
* @since 4.5.0
* @access public
*
* @see WP_Rewrite::$rewritecode
* @see WP_Rewrite::$rewritereplace
@@ -871,7 +825,6 @@ class WP_Rewrite {
* so best just ignore the contents and move to the parameters.
*
* @since 1.5.0
* @access public
*
* @param string $permalink_structure The permalink structure.
* @param int $ep_mask Optional. Endpoint mask defining what endpoints are added to the structure.
@@ -1237,7 +1190,6 @@ class WP_Rewrite {
* rewrite rules does.
*
* @since 1.5.0
* @access public
*
* @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
*
@@ -1263,7 +1215,6 @@ class WP_Rewrite {
* from the function.
*
* @since 1.5.0
* @access public
*
* @return array An associate array of matches and queries.
*/
@@ -1466,7 +1417,6 @@ class WP_Rewrite {
* in the form of caching.
*
* @since 1.5.0
* @access public
*
* @return array Rewrite rules.
*/
@@ -1495,7 +1445,6 @@ class WP_Rewrite {
* the WordPress rewrite rules one.
*
* @since 1.5.0
* @access public
*
* @return string
*/
@@ -1580,7 +1529,6 @@ class WP_Rewrite {
* the process that will.
*
* @since 2.8.0
* @access public
*
* @param bool $add_parent_tags Optional. Whether to add parent tags to the rewrite rule sets.
* Default false.
@@ -1633,7 +1581,6 @@ class WP_Rewrite {
*
* @since 2.1.0
* @since 4.4.0 Array support was added to the `$query` parameter.
* @access public
*
* @param string $regex Regular expression to match request against.
* @param string|array $query The corresponding query vars for this rewrite rule.
@@ -1667,7 +1614,6 @@ class WP_Rewrite {
* Adds a rewrite rule that doesn't correspond to index.php.
*
* @since 2.1.0
* @access public
*
* @param string $regex Regular expression to match request against.
* @param string $query The corresponding query vars for this rewrite rule.
@@ -1682,7 +1628,6 @@ class WP_Rewrite {
* @since 2.1.0
* @since 3.9.0 $query_var parameter added.
* @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
* @access public
*
* @see add_rewrite_endpoint() for full documentation.
* @global WP $wp
@@ -1722,7 +1667,6 @@ class WP_Rewrite {
* works on the new permastruct.
*
* @since 2.5.0
* @access public
*
* @param string $name Name for permalink structure.
* @param string $struct Permalink structure (e.g. category/%category%)
@@ -1778,7 +1722,6 @@ class WP_Rewrite {
* Removes a permalink structure.
*
* @since 4.5.0
* @access public
*
* @param string $name Name for permalink structure.
*/
@@ -1793,7 +1736,6 @@ class WP_Rewrite {
* If the function named 'save_mod_rewrite_rules' exists, it will be called.
*
* @since 2.0.1
* @access public
*
* @staticvar bool $do_hard_later
*
@@ -1843,7 +1785,6 @@ class WP_Rewrite {
* '%tag%', or '%author%'.
*
* @since 1.5.0
* @access public
*/
public function init() {
$this->extra_rules = $this->non_wp_rules = $this->endpoints = array();
@@ -1880,7 +1821,6 @@ class WP_Rewrite {
* processed passing the old and new values
*
* @since 1.5.0
* @access public
*
* @param string $permalink_structure Permalink structure.
*/
@@ -1911,7 +1851,6 @@ class WP_Rewrite {
* after the option is updated.
*
* @since 1.5.0
* @access public
*
* @param string $category_base Category permalink structure base.
*/
@@ -1930,7 +1869,6 @@ class WP_Rewrite {
* the option is updated.
*
* @since 2.3.0
* @access public
*
* @param string $tag_base Tag permalink structure base.
*/
@@ -1945,7 +1883,6 @@ class WP_Rewrite {
* Constructor - Calls init(), which runs setup.
*
* @since 1.5.0
* @access public
*
*/
public function __construct() {