WordPress.org
Get WordPress

Make WordPress Core

Changeset 37539


Ignore:
Timestamp:
05/23/2016 06:53:05 PM (10 years ago)
Author:
DrewAPicture
Message:

Docs: Apply inline @see tags to hooks referenced in DocBlocks for core classes.

Applying these specially-crafted @see tags allows the Code Reference parser to recognize and link these elements as actions and filters.

See #36921.

Location:
trunk/src/wp-includes
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-comment-query.php

    r37492 r37539  
    6363         * SQL WHERE clause.
    6464         *
    65          * Stored after the 'comments_clauses' filter is run on the compiled WHERE sub-clauses.
     65         * Stored after the {@see 'comments_clauses'} filter is run on the compiled WHERE sub-clauses.
    6666         *
    6767         * @since 4.4.2

  • trunk/src/wp-includes/class-wp-customize-manager.php

    r37527 r37539  
    906906         * @since 3.4.0
    907907         *
    908          * @param mixed $return Value passed through for wp_die_handler filter.
    909          * @return mixed Value passed through for wp_die_handler filter.
     908         * @param mixed $return Value passed through for {@see 'wp_die_handler'} filter.
     909         * @return mixed Value passed through for {@see 'wp_die_handler'} filter.
    910910         */
    911911        public function remove_preview_signature( $return = null ) {

  • trunk/src/wp-includes/class-wp-customize-widgets.php

    r37491 r37539  
    350350         * Ensures widgets are available for all types of previews.
    351351         *
    352          * When in preview, hook to 'customize_register' for settings after WordPress is loaded
     352         * When in preview, hook to {@see 'customize_register'} for settings after WordPress is loaded
    353353         * so that all filters have been initialized (e.g. Widget Visibility).
    354354         *
    … …  
    557557         *
    558558         * This method will return all Core widgets as being not wide, but this can be
    559          * overridden with the is_wide_widget_in_customizer filter.
     559         * overridden with the {@see 'is_wide_widget_in_customizer'} filter.
    560560         *
    561561         * @since 3.9.0
    … …  
    19901990
    19911991        /**
    1992          * @since 3.9.0
    1993          * @deprecated 4.2.0 Deprecated in favor of customize_dynamic_setting_args filter.
     1992         * {@internal Missing Summary}
     1993         *
     1994         * See the {@see 'customize_dynamic_setting_args'} filter.
     1995         *
     1996         * @since 3.9.0
     1997         * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter.
    19941998         */
    19951999        public function setup_widget_addition_previews() {
    … …  
    19982002
    19992003        /**
    2000          * @since 3.9.0
    2001          * @deprecated 4.2.0 Deprecated in favor of customize_dynamic_setting_args filter.
     2004         * {@internal Missing Summary}
     2005         *
     2006         * See the {@see 'customize_dynamic_setting_args'} filter.
     2007         *
     2008         * @since 3.9.0
     2009         * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter.
    20022010         */
    20032011        public function prepreview_added_sidebars_widgets() {
    … …  
    20062014
    20072015        /**
    2008          * @since 3.9.0
    2009          * @deprecated 4.2.0 Deprecated in favor of customize_dynamic_setting_args filter.
     2016         * {@internal Missing Summary}
     2017         *
     2018         * See the {@see 'customize_dynamic_setting_args'} filter.
     2019         *
     2020         * @since 3.9.0
     2021         * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter.
    20102022         */
    20112023        public function prepreview_added_widget_instance() {
    … …  
    20142026
    20152027        /**
    2016          * @since 3.9.0
    2017          * @deprecated 4.2.0 Deprecated in favor of customize_dynamic_setting_args filter.
     2028         * {@internal Missing Summary}
     2029         *
     2030         * See the {@see 'customize_dynamic_setting_args'} filter.
     2031         *
     2032         * @since 3.9.0
     2033         * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter.
    20182034         */
    20192035        public function remove_prepreview_filters() {

  • trunk/src/wp-includes/class-wp-embed.php

    r37492 r37539  
    1717        /**
    1818         * When a URL cannot be embedded, return false instead of returning a link
    19          * or the URL. Bypasses the 'embed_maybe_make_link' filter.
     19         * or the URL.
     20         *
     21         * Bypasses the {@see 'embed_maybe_make_link'} filter.
     22         *
     23         * @access public
     24         * @var bool
    2025         */
    2126        public $return_false_on_fail = false;

  • trunk/src/wp-includes/class-wp-metadata-lazyloader.php

    r36899 r37539  
    161161         * @since 4.5.0
    162162         *
    163          * @param mixed $check The `$check` param passed from the 'get_comment_metadata' hook.
     163         * @param mixed $check The `$check` param passed from the {@see 'get_comment_metadata'} hook.
    164164         * @return mixed The original value of `$check`, so as not to short-circuit `get_comment_metadata()`.
    165165         */

  • trunk/src/wp-includes/class-wp-rewrite.php

    r37492 r37539  
    12531253         * Constructs rewrite matches and queries from permalink structure.
    12541254         *
    1255          * Runs the action 'generate_rewrite_rules' with the parameter that is an
     1255         * Runs the action {@see 'generate_rewrite_rules'} with the parameter that is an
    12561256         * reference to the current WP_Rewrite instance to further manipulate the
    1257          * permalink structures and rewrite rules. Runs the 'rewrite_rules_array'
     1257         * permalink structures and rewrite rules. Runs the {@see 'rewrite_rules_array'}
    12581258         * filter on the full rewrite rule array.
    12591259         *
    12601260         * There are two ways to manipulate the rewrite rules, one by hooking into
    1261          * the 'generate_rewrite_rules' action and gaining full control of the
     1261         * the {@see 'generate_rewrite_rules'} action and gaining full control of the
    12621262         * object or just manipulating the rewrite rule array before it is passed
    12631263         * from the function.
    … …  
    18731873         * WP_Rewrite::init() after the option is updated.
    18741874         *
    1875          * Fires the 'permalink_structure_changed' action once the init call has
     1875         * Fires the {@see 'permalink_structure_changed'} action once the init call has
    18761876         * processed passing the old and new values
    18771877         *

  • trunk/src/wp-includes/class-wp-theme.php

    r37492 r37539  
    171171         * Flag for whether the themes cache bucket should be persistently cached.
    172172         *
    173          * Default is false. Can be set with the wp_cache_themes_persistently filter.
     173         * Default is false. Can be set with the {@see 'wp_cache_themes_persistently'} filter.
    174174         *
    175175         * @static
    … …  
    921921         * This is typically the absolute URL to wp-content/themes. This forms the basis
    922922         * for all other URLs returned by WP_Theme, so we pass it to the public function
    923          * get_theme_root_uri() and allow it to run the theme_root_uri filter.
     923         * get_theme_root_uri() and allow it to run the {@see 'theme_root_uri'} filter.
    924924         *
    925925         * @since 3.4.0

  • trunk/src/wp-includes/class-wp-xmlrpc-server.php

    r37492 r37539  
    1515 *
    1616 * As of WordPress 3.5.0, XML-RPC is enabled by default. It can be disabled
    17  * via the xmlrpc_enabled filter found in wp_xmlrpc_server::login().
     17 * via the {@see 'xmlrpc_enabled'} filter found in wp_xmlrpc_server::login().
    1818 *
    1919 * @package WordPress
    … …  
    5555
    5656        /**
    57          * Register all of the XMLRPC methods that XMLRPC server understands.
     57         * Registers all of the XMLRPC methods that XMLRPC server understands.
    5858         *
    5959         * Sets up server and method property. Passes XMLRPC
    60          * methods through the 'xmlrpc_methods' filter to allow plugins to extend
    61          * or replace XMLRPC methods.
     60         * methods through the {@see 'xmlrpc_methods'} filter to allow plugins to extend
     61         * or replace XML-RPC methods.
    6262         *
    6363         * @since 1.5.0

  • trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

    r37518 r37539  
    132132        /**
    133133         * Status for calling the update method, used in customize_save_response filter.
     134         *
     135         * See {@see 'customize_save_response'}.
    134136         *
    135137         * When status is inserted, the placeholder post ID is stored in $previous_post_id.
    … …  
    659661
    660662        /**
    661          * Create/update the nav_menu_item post for this setting.
     663         * Creates/updates the nav_menu_item post for this setting.
    662664         *
    663665         * Any created menu items will have their assigned post IDs exported to the client
    664          * via the customize_save_response filter. Likewise, any errors will be exported
    665          * to the client via the customize_save_response() filter.
     666         * via the {@see 'customize_save_response'} filter. Likewise, any errors will be
     667         * exported to the client via the customize_save_response() filter.
    666668         *
    667669         * To delete a menu, the client can send false as the value.

  • trunk/src/wp-includes/customize/class-wp-customize-nav-menu-setting.php

    r37518 r37539  
    7575         * Previous (placeholder) term ID used before creating a new menu.
    7676         *
    77          * This value will be exported to JS via the customize_save_response filter
     77         * This value will be exported to JS via the {@see 'customize_save_response'} filter
    7878         * so that JavaScript can update the settings to refer to the newly-assigned
    7979         * term ID. This value is always negative to indicate it does not refer to
    … …  
    101101         * Status for calling the update method, used in customize_save_response filter.
    102102         *
    103          * When status is inserted, the placeholder term ID is stored in $previous_term_id.
    104          * When status is error, the error is stored in $update_error.
     103         * See {@see 'customize_save_response'}.
     104         *
     105         * When status is inserted, the placeholder term ID is stored in `$previous_term_id`.
     106         * When status is error, the error is stored in `$update_error`.
    105107         *
    106108         * @since 4.3.0
    … …  
    448450         * Storage for data to be sent back to client in customize_save_response filter.
    449451         *
     452         * See {@see 'customize_save_response'}.
     453         *
    450454         * @access protected
    451455         * @since 4.3.0
    … …  
    460464         *
    461465         * Any created menus will have their assigned term IDs exported to the client
    462          * via the customize_save_response filter. Likewise, any errors will be exported
     466         * via the {@see 'customize_save_response'} filter. Likewise, any errors will be exported
    463467         * to the client via the customize_save_response() filter.
    464468         *
Note: See TracChangeset for help on using the changeset viewer.