wordpress中的类class-wp中各成员变量的作用

wp-includes/class-wp.php是wordpress中最基础的一个类,包含以下成员变量:

/**
     * Public query variables.
     *
     * Long list of public query variables.
     *
     * @since 2.0.0
     * @var array
     */
    public $public_query_vars = array('m', 'p', 'posts', 'w', 'cat', 'withcomments', 'withoutcomments', 's', 'search', 'exact', 'sentence', 'calendar', 'page', 'paged', 'more', 'tb', 'pb', 'author', 'order', 'orderby', 'year', 'monthnum', 'day', 'hour', 'minute', 'second', 'name', 'category_name', 'tag', 'feed', 'author_name', 'static', 'pagename', 'page_id', 'error', 'attachment', 'attachment_id', 'subpost', 'subpost_id', 'preview', 'robots', 'taxonomy', 'term', 'cpage', 'post_type', 'embed' );

    /**
     * Private query variables.
     *
     * Long list of private query variables.
     *
     * @since 2.0.0
     * @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', 'fields' );

    /**
     * Extra query variables set by the user.
     *
     * @since 2.1.0
     * @var array
     */
    public $extra_query_vars = array();

    /**
     * Query variables for setting up the WordPress Query Loop.
     *
     * @since 2.0.0
     * @var array
     */
    public $query_vars;

    /**
     * String parsed to set the query variables.
     *
     * @since 2.0.0
     * @var string
     */
    public $query_string;

    /**
     * The request path, e.g. 2015/05/06.
     *
     * @since 2.0.0
     * @var string
     */
    public $request;

    /**
     * Rewrite rule the request matched.
     *
     * @since 2.0.0
     * @var string
     */
    public $matched_rule;

    /**
     * Rewrite query the request matched.
     *
     * @since 2.0.0
     * @var string
     */
    public $matched_query;

    /**
     * Whether already did the permalink.
     *
     * @since 2.0.0
     * @var bool
     */
    public $did_permalink = false;

光看命名和注释真的很难理解它们具体的用途,我找遍了主流的中文和英文社区都没有找到详细的说明,便只能自己瞎推测了。

发送请求:index.php/2018/01/23/hello-world/,断点调试观察处理请求后WP对象中各变量的值:

从截图的值可以推测以下变量的作用:

request

url的相对路径。

matched_rule,query_vars,query_string,matched_query

matched_rule是当前url符合路由规则,这条规则在wp_rewrite中被定义如下:

"index.php/([0-9]{4})/([0-9]{1,2})/([0-9]{1,2})/([^/]+)(?:/([0-9]+))?/?$":"index.php?year=$matches[1]&monthnum=$matches[2]&day=$matches[3]&name=$matches[4]&page=$matches[5]"

找到符合的路由之后就能知道url中的每个参数代表什么意思,query_vars用来存储这些参数,matched_query是query_vars的字符串形式,query_string是matched_query的有效部分,可能会被用来拼成SQL语句。

did_permalink

网上有很多解释,简单来说它的作用是:让指向特定博文的url更好看;这种风格的url可以更多的被搜索引擎检索到。
更多信息:https://codex.wordpress.org/Using_Permalinks

public_query_vars、private_query_vars、extra_query_vars

观察请求处理后public_query_vars中的值:

数组public_query_vars中有46个初始值,请求解析完成之后数组容量变成了48,实际储存的值却只有32个,说明经历了增和减的过程。观察项目中public_query_vars被增和被减的各个情况可以得出结论:public_query_vars总是伴随着add_rewrite_rules方法的使用而增加,伴随着remove_rewrite_rules方法的使用而减少;再观察public_query_vars被使用的逻辑:

        foreach ( $this->public_query_vars as $wpvar ) {
            if ( isset( $this->extra_query_vars[$wpvar] ) )
                $this->query_vars[$wpvar] = $this->extra_query_vars[$wpvar];
            elseif ( isset( $_POST[$wpvar] ) )
                $this->query_vars[$wpvar] = $_POST[$wpvar];
            elseif ( isset( $_GET[$wpvar] ) )
                $this->query_vars[$wpvar] = $_GET[$wpvar];
            elseif ( isset( $perma_query_vars[$wpvar] ) )
                $this->query_vars[$wpvar] = $perma_query_vars[$wpvar];

            if ( !empty( $this->query_vars[$wpvar] ) ) {
                if ( ! is_array( $this->query_vars[$wpvar] ) ) {
                    $this->query_vars[$wpvar] = (string) $this->query_vars[$wpvar];
                } else {
                    foreach ( $this->query_vars[$wpvar] as $vkey => $v ) {
                        if ( !is_object( $v ) ) {
                            $this->query_vars[$wpvar][$vkey] = (string) $v;
                        }
                    }
                }

                if ( isset($post_type_query_vars[$wpvar] ) ) {
                    $this->query_vars['post_type'] = $post_type_query_vars[$wpvar];
                    $this->query_vars['name'] = $this->query_vars[$wpvar];
                }
            }
        }

这段代码的作用:客户端发送的url可能包括很多参数,但这些参数想要被插入到SQL语句中则需要满足:它的键必须已经存在与public_query_vars中。或者同时存在于private_query_vars和extra_query_vars:

        foreach ( (array) $this->private_query_vars as $var) {
            if ( isset($this->extra_query_vars[$var]) )
                $this->query_vars[$var] = $this->extra_query_vars[$var];
        }

private_query_vars的值通常不会变,因为不能随便什么参数都放你进来,extra_query_vars的值可以通过钩子函数do_parse_request来改变。这三个变量共同作用于从请求中筛选可用的参数,防止SQL注入,保证数据库的安全。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容