Make WordPress Core


Ignore:
Timestamp:
10/26/2019 09:07:10 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Switch more docs over to typed array notation, plus some fixes.

See #48303, #41756

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-rewrite.php

    r46141 r46596  
    855855     * @param bool   $endpoints           Optional. Whether endpoints should be applied to the generated rewrite rules.
    856856     *                                    Default true.
    857      * @return array Rewrite rule list.
     857     * @return string[] Array of rewrite rules keyed by their regex pattern.
    858858     */
    859859    public function generate_rewrite_rules( $permalink_structure, $ep_mask = EP_NONE, $paged = true, $feed = true, $forcomments = false, $walk_dirs = true, $endpoints = true ) {
     
    12881288         * @since 1.5.0
    12891289         *
    1290          * @param array $post_rewrite The rewrite rules for posts.
     1290         * @param string[] $post_rewrite Array of rewrite rules for posts, keyed by their regex pattern.
    12911291         */
    12921292        $post_rewrite = apply_filters( 'post_rewrite_rules', $post_rewrite );
     
    13021302         * @since 1.5.0
    13031303         *
    1304          * @param array $date_rewrite The rewrite rules for date archives.
     1304         * @param string[] $date_rewrite Array of rewrite rules for date archives, keyed by their regex pattern.
    13051305         */
    13061306        $date_rewrite = apply_filters( 'date_rewrite_rules', $date_rewrite );
     
    13171317         * @since 1.5.0
    13181318         *
    1319          * @param array $root_rewrite The root-level rewrite rules.
     1319         * @param string[] $root_rewrite Array of root-level rewrite rules, keyed by their regex pattern.
    13201320         */
    13211321        $root_rewrite = apply_filters( 'root_rewrite_rules', $root_rewrite );
     
    13311331         * @since 1.5.0
    13321332         *
    1333          * @param array $comments_rewrite The rewrite rules for the site-wide comments feeds.
     1333         * @param string[] $comments_rewrite Array of rewrite rules for the site-wide comments feeds, keyed by their regex pattern.
    13341334         */
    13351335        $comments_rewrite = apply_filters( 'comments_rewrite_rules', $comments_rewrite );
     
    13471347         * @since 1.5.0
    13481348         *
    1349          * @param array $search_rewrite The rewrite rules for search queries.
     1349         * @param string[] $search_rewrite Array of rewrite rules for search queries, keyed by their regex pattern.
    13501350         */
    13511351        $search_rewrite = apply_filters( 'search_rewrite_rules', $search_rewrite );
     
    13621362         * @since 1.5.0
    13631363         *
    1364          * @param array $author_rewrite The rewrite rules for author archives.
     1364         * @param string[] $author_rewrite Array of rewrite rules for author archives, keyed by their regex pattern.
    13651365         */
    13661366        $author_rewrite = apply_filters( 'author_rewrite_rules', $author_rewrite );
     
    13741374         * @since 1.5.0
    13751375         *
    1376          * @param array $page_rewrite The rewrite rules for the "page" post type.
     1376         * @param string[] $page_rewrite Array of rewrite rules for the "page" post type, keyed by their regex pattern.
    13771377         */
    13781378        $page_rewrite = apply_filters( 'page_rewrite_rules', $page_rewrite );
     
    13991399             * @since 3.1.0
    14001400             *
    1401              * @param array $rules The rewrite rules generated for the current permastruct.
     1401             * @param string[] $rules Array of rewrite rules generated for the current permastruct, keyed by their regex pattern.
    14021402             */
    14031403            $rules = apply_filters( "{$permastructname}_rewrite_rules", $rules );
     
    14101410                 * @deprecated 3.1.0 Use 'post_tag_rewrite_rules' instead
    14111411                 *
    1412                  * @param array $rules The rewrite rules generated for tags.
     1412                 * @param string[] $rules Array of rewrite rules generated for tags, keyed by their regex pattern.
    14131413                 */
    14141414                $rules = apply_filters( 'tag_rewrite_rules', $rules );
     
    14391439         * @since 1.5.0
    14401440         *
    1441          * @param array $this->rules The compiled array of rewrite rules.
     1441         * @param string[] $this->rules The compiled array of rewrite rules, keyed by their regex pattern.
    14421442         */
    14431443        $this->rules = apply_filters( 'rewrite_rules_array', $this->rules );
Note: See TracChangeset for help on using the changeset viewer.