WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/02/2016 03:59:56 AM (5 years ago)
Author:
DrewAPicture
Message:

Docs: Remove inline @see tags from function, class, and method references in inline docs.

Known functions, classes, and methods are now auto-linked in Code Reference pages following #meta1483.

Note: Hook references are still linked via inline @see tags due to the unlikelihood of reliably matching for known hooks based on a RegEx pattern.

See #32246.

File:
1 edited

Legend:

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

    r37272 r37342  
    4343     * The result of the installation.
    4444     *
    45      * This is set by {@see WP_Upgrader::install_package()}, only when the package is installed
    46      * successfully. It will then be an array, unless a {@see WP_Error} is returned by the
    47      * {@see 'upgrader_post_install'} filter. In that case, the `WP_Error` will be assigned to
     45     * This is set by WP_Upgrader::install_package(), only when the package is installed
     46     * successfully. It will then be an array, unless a WP_Error is returned by the
     47     * {@see 'upgrader_post_install'} filter. In that case, the WP_Error will be assigned to
    4848     * it.
    4949     *
     
    9494     * @access public
    9595     *
    96      * @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a {@see WP_Upgrader_Skin}
     96     * @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a WP_Upgrader_Skin.
    9797     *                               instance.
    9898     */
     
    156156     *
    157157     * @param array $directories                  Optional. A list of directories. If any of these do
    158      *                                            not exist, a {@see WP_Error} object will be returned.
     158     *                                            not exist, a WP_Error object will be returned.
    159159     *                                            Default empty array.
    160160     * @param bool  $allow_relaxed_file_ownership Whether to allow relaxed file ownership.
    161161     *                                            Default false.
    162      * @return bool|WP_Error True if able to connect, false or a {@see WP_Error} otherwise.
     162     * @return bool|WP_Error True if able to connect, false or a WP_Error otherwise.
    163163     */
    164164    public function fs_connect( $directories = array(), $allow_relaxed_file_ownership = false ) {
     
    219219     * @param string $package The URI of the package. If this is the full path to an
    220220     *                        existing local file, it will be returned untouched.
    221      * @return string|WP_Error The full path to the downloaded package file, or a {@see WP_Error} object.
     221     * @return string|WP_Error The full path to the downloaded package file, or a WP_Error object.
    222222     */
    223223    public function download_package( $package ) {
     
    265265     * @param bool   $delete_package Optional. Whether to delete the package file after attempting
    266266     *                               to unpack it. Default true.
    267      * @return string|WP_Error The path to the unpacked contents, or a {@see WP_Error} on failure.
     267     * @return string|WP_Error The path to the unpacked contents, or a WP_Error on failure.
    268268     */
    269269    public function unpack_package( $package, $delete_package = true ) {
     
    392392     *                                               the destination folder already exists. Default true.
    393393     *     @type array  $hook_extra                  Extra arguments to pass to the filter hooks called by
    394      *                                               {@see WP_Upgrader::install_package()}. Default empty array.
     394     *                                               WP_Upgrader::install_package(). Default empty array.
    395395     * }
    396396     *
    397      * @return array|WP_Error The result (also stored in `WP_Upgrader:$result`), or a {@see WP_Error} on failure.
     397     * @return array|WP_Error The result (also stored in `WP_Upgrader::$result`), or a WP_Error on failure.
    398398     */
    399399    public function install_package( $args = array() ) {
     
    601601     *     @type bool   $is_multi                    Whether this run is one of multiple upgrade/install
    602602     *                                               actions being performed in bulk. When true, the skin
    603      *                                               {@see WP_Upgrader::header()} and {@see WP_Upgrader::footer()}
     603     *                                               WP_Upgrader::header() and WP_Upgrader::footer()
    604604     *                                               aren't called. Default false.
    605605     *     @type array  $hook_extra                  Extra arguments to pass to the filter hooks called by
    606      *                                               {@see WP_Upgrader::run()}.
     606     *                                               WP_Upgrader::run().
    607607     * }
    608608     * @return array|false|WP_error The result from self::install_package() on success, otherwise a WP_Error,
     
    950950     *                                    Default true.
    951951     * }
    952      * @return bool|WP_Error True if the upgrade was successful, false or a {@see WP_Error} object otherwise.
     952     * @return bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise.
    953953     */
    954954    public function upgrade( $plugin, $args = array() ) {
     
    11441144     *
    11451145     * This function is added to the {@see 'upgrader_source_selection'} filter by
    1146      * {@see Plugin_Upgrader::install()}.
     1146     * Plugin_Upgrader::install().
    11471147     *
    11481148     * @since 3.3.0
     
    11521152     *
    11531153     * @param string $source The path to the downloaded package source.
    1154      * @return string|WP_Error The source as passed, or a {@see WP_Error} object
     1154     * @return string|WP_Error The source as passed, or a WP_Error object
    11551155     *                         if no plugins were found.
    11561156     */
     
    12121212     * Deactivates a plugin before it is upgraded.
    12131213     *
    1214      * Hooked to the {@see 'upgrader_pre_install'} filter by {@see Plugin_Upgrader::upgrade()}.
     1214     * Hooked to the {@see 'upgrader_pre_install'} filter by Plugin_Upgrader::upgrade().
    12151215     *
    12161216     * @since 2.8.0
     
    12201220     * @param bool|WP_Error  $return Upgrade offer return.
    12211221     * @param array          $plugin Plugin package arguments.
    1222      * @return bool|WP_Error The passed in $return param or {@see WP_Error}.
     1222     * @return bool|WP_Error The passed in $return param or WP_Error.
    12231223     */
    12241224    public function deactivate_plugin_before_upgrade($return, $plugin) {
     
    12471247     *
    12481248     * Hooked to the {@see 'upgrader_clear_destination'} filter by
    1249      * {@see Plugin_Upgrader::upgrade()} and {@see Plugin_Upgrader::bulk_upgrade()}.
     1249     * Plugin_Upgrader::upgrade() and Plugin_Upgrader::bulk_upgrade().
    12501250     *
    12511251     * @since 2.8.0
     
    13661366     * Check if a child theme is being installed and we need to install its parent.
    13671367     *
    1368      * Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::install()}.
     1368     * Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::install().
    13691369     *
    13701370     * @since 3.4.0
     
    14391439     *
    14401440     * Hooked to the {@see 'install_theme_complete_actions'} filter by
    1441      * {@see Theme_Upgrader::check_parent_theme_filter()} when installing
     1441     * Theme_Upgrader::check_parent_theme_filter() when installing
    14421442     * a child theme and installing the parent theme fails.
    14431443     *
     
    14681468     * }
    14691469     *
    1470      * @return bool|WP_Error True if the install was successful, false or a {@see WP_Error} object otherwise.
     1470     * @return bool|WP_Error True if the install was successful, false or a WP_Error object otherwise.
    14711471     */
    14721472    public function install( $package, $args = array() ) {
     
    15231523     *                                    Default true.
    15241524     * }
    1525      * @return bool|WP_Error True if the upgrade was successful, false or a {@see WP_Error} object otherwise.
     1525     * @return bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise.
    15261526     */
    15271527    public function upgrade( $theme, $args = array() ) {
     
    17021702     * Check that the package source contains a valid theme.
    17031703     *
    1704      * Hooked to the {@see 'upgrader_source_selection'} filter by {@see Theme_Upgrader::install()}.
     1704     * Hooked to the {@see 'upgrader_source_selection'} filter by Theme_Upgrader::install().
    17051705     * It will return an error if the theme doesn't have style.css or index.php
    17061706     * files.
     
    17621762     * Turn on maintenance mode before attempting to upgrade the current theme.
    17631763     *
    1764      * Hooked to the {@see 'upgrader_pre_install'} filter by {@see Theme_Upgrader::upgrade()} and
    1765      * {@see Theme_Upgrader::bulk_upgrade()}.
     1764     * Hooked to the {@see 'upgrader_pre_install'} filter by Theme_Upgrader::upgrade() and
     1765     * Theme_Upgrader::bulk_upgrade().
    17661766     *
    17671767     * @since 2.8.0
     
    17901790     * Turn off maintenance mode after upgrading the current theme.
    17911791     *
    1792      * Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::upgrade()}
    1793      * and {@see Theme_Upgrader::bulk_upgrade()}.
     1792     * Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::upgrade()
     1793     * and Theme_Upgrader::bulk_upgrade().
    17941794     *
    17951795     * @since 2.8.0
     
    18251825     * Delete the old theme during an upgrade.
    18261826     *
    1827      * Hooked to the {@see 'upgrader_clear_destination'} filter by {@see Theme_Upgrader::upgrade()}
    1828      * and {@see Theme_Upgrader::bulk_upgrade()}.
     1827     * Hooked to the {@see 'upgrader_clear_destination'} filter by Theme_Upgrader::upgrade()
     1828     * and Theme_Upgrader::bulk_upgrade().
    18291829     *
    18301830     * @since 2.8.0
     
    20052005     * @param string|false $update Optional. Whether an update offer is available. Default false.
    20062006     * @param array        $args   Optional. Other optional arguments, see
    2007      *                             {@see Language_Pack_Upgrader::bulk_upgrade()}. Default empty array.
    2008      * @return array|bool|WP_Error The result of the upgrade, or a {@see wP_Error} object instead.
     2007     *                             Language_Pack_Upgrader::bulk_upgrade(). Default empty array.
     2008     * @return array|bool|WP_Error The result of the upgrade, or a WP_Error object instead.
    20092009     */
    20102010    public function upgrade( $update = false, $args = array() ) {
     
    21512151     *
    21522152     * Hooked to the {@see 'upgrader_source_selection'} filter by
    2153      * {@see Language_Pack_Upgrader::bulk_upgrade()}.
     2153     * Language_Pack_Upgrader::bulk_upgrade().
    21542154     *
    21552155     * @since 3.7.0
Note: See TracChangeset for help on using the changeset viewer.