Docs: Add missing `@access` tags to DocBlocks for `WP` class methods and properties.
See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@36365 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
2ed7c6d857
commit
8ae1899929
|
@ -23,6 +23,7 @@ class WP {
|
||||||
* Long list of private query variables.
|
* Long list of private query variables.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
* @var array
|
* @var array
|
||||||
*/
|
*/
|
||||||
public $private_query_vars = array( 'offset', 'posts_per_page', 'posts_per_archive_page', 'showposts', 'nopaging', 'post_type', 'post_status', 'category__in', 'category__not_in', 'category__and', 'tag__in', 'tag__not_in', 'tag__and', 'tag_slug__in', 'tag_slug__and', 'tag_id', 'post_mime_type', 'perm', 'comments_per_page', 'post__in', 'post__not_in', 'post_parent', 'post_parent__in', 'post_parent__not_in', 'title' );
|
public $private_query_vars = array( 'offset', 'posts_per_page', 'posts_per_archive_page', 'showposts', 'nopaging', 'post_type', 'post_status', 'category__in', 'category__not_in', 'category__and', 'tag__in', 'tag__not_in', 'tag__and', 'tag_slug__in', 'tag_slug__and', 'tag_id', 'post_mime_type', 'perm', 'comments_per_page', 'post__in', 'post__not_in', 'post_parent', 'post_parent__in', 'post_parent__not_in', 'title' );
|
||||||
|
@ -31,6 +32,7 @@ class WP {
|
||||||
* Extra query variables set by the user.
|
* Extra query variables set by the user.
|
||||||
*
|
*
|
||||||
* @since 2.1.0
|
* @since 2.1.0
|
||||||
|
* @access public
|
||||||
* @var array
|
* @var array
|
||||||
*/
|
*/
|
||||||
public $extra_query_vars = array();
|
public $extra_query_vars = array();
|
||||||
|
@ -39,6 +41,7 @@ class WP {
|
||||||
* Query variables for setting up the WordPress Query Loop.
|
* Query variables for setting up the WordPress Query Loop.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
* @var array
|
* @var array
|
||||||
*/
|
*/
|
||||||
public $query_vars;
|
public $query_vars;
|
||||||
|
@ -47,6 +50,7 @@ class WP {
|
||||||
* String parsed to set the query variables.
|
* String parsed to set the query variables.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
public $query_string;
|
public $query_string;
|
||||||
|
@ -55,6 +59,7 @@ class WP {
|
||||||
* Permalink or requested URI.
|
* Permalink or requested URI.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
public $request;
|
public $request;
|
||||||
|
@ -63,6 +68,7 @@ class WP {
|
||||||
* Rewrite rule the request matched.
|
* Rewrite rule the request matched.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
public $matched_rule;
|
public $matched_rule;
|
||||||
|
@ -71,6 +77,7 @@ class WP {
|
||||||
* Rewrite query the request matched.
|
* Rewrite query the request matched.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
public $matched_query;
|
public $matched_query;
|
||||||
|
@ -79,6 +86,7 @@ class WP {
|
||||||
* Whether already did the permalink.
|
* Whether already did the permalink.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
* @var bool
|
* @var bool
|
||||||
*/
|
*/
|
||||||
public $did_permalink = false;
|
public $did_permalink = false;
|
||||||
|
@ -87,6 +95,7 @@ class WP {
|
||||||
* Add name to list of public query variables.
|
* Add name to list of public query variables.
|
||||||
*
|
*
|
||||||
* @since 2.1.0
|
* @since 2.1.0
|
||||||
|
* @access public
|
||||||
*
|
*
|
||||||
* @param string $qv Query variable name.
|
* @param string $qv Query variable name.
|
||||||
*/
|
*/
|
||||||
|
@ -99,6 +108,7 @@ class WP {
|
||||||
* Remove name from list of public query variables.
|
* Remove name from list of public query variables.
|
||||||
*
|
*
|
||||||
* @since 4.5.0
|
* @since 4.5.0
|
||||||
|
* @access public
|
||||||
*
|
*
|
||||||
* @param string $name Query variable name.
|
* @param string $name Query variable name.
|
||||||
*/
|
*/
|
||||||
|
@ -110,6 +120,7 @@ class WP {
|
||||||
* Set the value of a query variable.
|
* Set the value of a query variable.
|
||||||
*
|
*
|
||||||
* @since 2.3.0
|
* @since 2.3.0
|
||||||
|
* @access public
|
||||||
*
|
*
|
||||||
* @param string $key Query variable name.
|
* @param string $key Query variable name.
|
||||||
* @param mixed $value Query variable value.
|
* @param mixed $value Query variable value.
|
||||||
|
@ -125,6 +136,7 @@ class WP {
|
||||||
* filters and actions that can be used to further manipulate the result.
|
* filters and actions that can be used to further manipulate the result.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
*
|
*
|
||||||
* @global WP_Rewrite $wp_rewrite
|
* @global WP_Rewrite $wp_rewrite
|
||||||
*
|
*
|
||||||
|
@ -381,6 +393,7 @@ class WP {
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
* @since 4.4.0 `X-Pingback` header is added conditionally after posts have been queried in handle_404().
|
* @since 4.4.0 `X-Pingback` header is added conditionally after posts have been queried in handle_404().
|
||||||
|
* @access public
|
||||||
*/
|
*/
|
||||||
public function send_headers() {
|
public function send_headers() {
|
||||||
$headers = array();
|
$headers = array();
|
||||||
|
@ -503,6 +516,7 @@ class WP {
|
||||||
* use the 'request' filter instead.
|
* use the 'request' filter instead.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
*/
|
*/
|
||||||
public function build_query_string() {
|
public function build_query_string() {
|
||||||
$this->query_string = '';
|
$this->query_string = '';
|
||||||
|
@ -536,6 +550,9 @@ class WP {
|
||||||
* be taken when naming global variables that might interfere with the
|
* be taken when naming global variables that might interfere with the
|
||||||
* WordPress environment.
|
* WordPress environment.
|
||||||
*
|
*
|
||||||
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
|
*
|
||||||
* @global WP_Query $wp_query
|
* @global WP_Query $wp_query
|
||||||
* @global string $query_string Query string for the loop.
|
* @global string $query_string Query string for the loop.
|
||||||
* @global array $posts The found posts.
|
* @global array $posts The found posts.
|
||||||
|
@ -544,8 +561,6 @@ class WP {
|
||||||
* @global int $more Only set, if single page or post.
|
* @global int $more Only set, if single page or post.
|
||||||
* @global int $single If single page or post. Only set, if single page or post.
|
* @global int $single If single page or post. Only set, if single page or post.
|
||||||
* @global WP_User $authordata Only set, if author archive.
|
* @global WP_User $authordata Only set, if author archive.
|
||||||
*
|
|
||||||
* @since 2.0.0
|
|
||||||
*/
|
*/
|
||||||
public function register_globals() {
|
public function register_globals() {
|
||||||
global $wp_query;
|
global $wp_query;
|
||||||
|
@ -573,6 +588,7 @@ class WP {
|
||||||
* Set up the current user.
|
* Set up the current user.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
*/
|
*/
|
||||||
public function init() {
|
public function init() {
|
||||||
wp_get_current_user();
|
wp_get_current_user();
|
||||||
|
@ -582,6 +598,7 @@ class WP {
|
||||||
* Set up the Loop based on the query variables.
|
* Set up the Loop based on the query variables.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
*
|
*
|
||||||
* @global WP_Query $wp_the_query
|
* @global WP_Query $wp_the_query
|
||||||
*/
|
*/
|
||||||
|
@ -605,6 +622,7 @@ class WP {
|
||||||
* a 404 so that canonical redirection logic can kick in.
|
* a 404 so that canonical redirection logic can kick in.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
*
|
*
|
||||||
* @global WP_Query $wp_query
|
* @global WP_Query $wp_query
|
||||||
*/
|
*/
|
||||||
|
@ -682,6 +700,7 @@ class WP {
|
||||||
* object.
|
* object.
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
|
* @access public
|
||||||
*
|
*
|
||||||
* @param string|array $query_args Passed to {@link parse_request()}
|
* @param string|array $query_args Passed to {@link parse_request()}
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue