diff --git a/wp-admin/includes/class-wp-list-table.php b/wp-admin/includes/class-wp-list-table.php index 32d0883947..2381751b87 100644 --- a/wp-admin/includes/class-wp-list-table.php +++ b/wp-admin/includes/class-wp-list-table.php @@ -125,7 +125,7 @@ class WP_List_Table { * Default empty * @type bool $ajax Whether the list table supports AJAX. This includes loading * and sorting data, for example. If true, the class will call - * the {@see _js_vars()} method in the footer to provide variables + * the _js_vars() method in the footer to provide variables * to any scripts handling AJAX events. Default false. * @type string $screen String containing the hook name used to determine the current * screen. If left null, the current screen will be automatically set. diff --git a/wp-admin/includes/class-wp-upgrader.php b/wp-admin/includes/class-wp-upgrader.php index 0d5e216e49..a6098406f9 100644 --- a/wp-admin/includes/class-wp-upgrader.php +++ b/wp-admin/includes/class-wp-upgrader.php @@ -42,9 +42,9 @@ class WP_Upgrader { /** * The result of the installation. * - * This is set by {@see WP_Upgrader::install_package()}, only when the package is installed - * successfully. It will then be an array, unless a {@see WP_Error} is returned by the - * {@see 'upgrader_post_install'} filter. In that case, the `WP_Error` will be assigned to + * This is set by WP_Upgrader::install_package(), only when the package is installed + * successfully. It will then be an array, unless a WP_Error is returned by the + * {@see 'upgrader_post_install'} filter. In that case, the WP_Error will be assigned to * it. * * @since 2.8.0 @@ -93,7 +93,7 @@ class WP_Upgrader { * @since 2.8.0 * @access public * - * @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a {@see WP_Upgrader_Skin} + * @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a WP_Upgrader_Skin. * instance. */ public function __construct( $skin = null ) { @@ -155,11 +155,11 @@ class WP_Upgrader { * @global WP_Filesystem_Base $wp_filesystem Subclass * * @param array $directories Optional. A list of directories. If any of these do - * not exist, a {@see WP_Error} object will be returned. + * not exist, a WP_Error object will be returned. * Default empty array. * @param bool $allow_relaxed_file_ownership Whether to allow relaxed file ownership. * Default false. - * @return bool|WP_Error True if able to connect, false or a {@see WP_Error} otherwise. + * @return bool|WP_Error True if able to connect, false or a WP_Error otherwise. */ public function fs_connect( $directories = array(), $allow_relaxed_file_ownership = false ) { global $wp_filesystem; @@ -218,7 +218,7 @@ class WP_Upgrader { * * @param string $package The URI of the package. If this is the full path to an * existing local file, it will be returned untouched. - * @return string|WP_Error The full path to the downloaded package file, or a {@see WP_Error} object. + * @return string|WP_Error The full path to the downloaded package file, or a WP_Error object. */ public function download_package( $package ) { @@ -264,7 +264,7 @@ class WP_Upgrader { * @param string $package Full path to the package file. * @param bool $delete_package Optional. Whether to delete the package file after attempting * to unpack it. Default true. - * @return string|WP_Error The path to the unpacked contents, or a {@see WP_Error} on failure. + * @return string|WP_Error The path to the unpacked contents, or a WP_Error on failure. */ public function unpack_package( $package, $delete_package = true ) { global $wp_filesystem; @@ -391,10 +391,10 @@ class WP_Upgrader { * @type bool $abort_if_destination_exists Whether to abort the installation if * the destination folder already exists. Default true. * @type array $hook_extra Extra arguments to pass to the filter hooks called by - * {@see WP_Upgrader::install_package()}. Default empty array. + * WP_Upgrader::install_package(). Default empty array. * } * - * @return array|WP_Error The result (also stored in `WP_Upgrader:$result`), or a {@see WP_Error} on failure. + * @return array|WP_Error The result (also stored in `WP_Upgrader::$result`), or a WP_Error on failure. */ public function install_package( $args = array() ) { global $wp_filesystem, $wp_theme_directories; @@ -600,10 +600,10 @@ class WP_Upgrader { * should be false. Default true. * @type bool $is_multi Whether this run is one of multiple upgrade/install * actions being performed in bulk. When true, the skin - * {@see WP_Upgrader::header()} and {@see WP_Upgrader::footer()} + * WP_Upgrader::header() and WP_Upgrader::footer() * aren't called. Default false. * @type array $hook_extra Extra arguments to pass to the filter hooks called by - * {@see WP_Upgrader::run()}. + * WP_Upgrader::run(). * } * @return array|false|WP_error The result from self::install_package() on success, otherwise a WP_Error, * or false if unable to connect to the filesystem. @@ -949,7 +949,7 @@ class Plugin_Upgrader extends WP_Upgrader { * @type bool $clear_update_cache Whether to clear the plugin updates cache if successful. * Default true. * } - * @return bool|WP_Error True if the upgrade was successful, false or a {@see WP_Error} object otherwise. + * @return bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise. */ public function upgrade( $plugin, $args = array() ) { @@ -1143,7 +1143,7 @@ class Plugin_Upgrader extends WP_Upgrader { * Check a source package to be sure it contains a plugin. * * This function is added to the {@see 'upgrader_source_selection'} filter by - * {@see Plugin_Upgrader::install()}. + * Plugin_Upgrader::install(). * * @since 3.3.0 * @access public @@ -1151,7 +1151,7 @@ class Plugin_Upgrader extends WP_Upgrader { * @global WP_Filesystem_Base $wp_filesystem Subclass * * @param string $source The path to the downloaded package source. - * @return string|WP_Error The source as passed, or a {@see WP_Error} object + * @return string|WP_Error The source as passed, or a WP_Error object * if no plugins were found. */ public function check_package($source) { @@ -1211,7 +1211,7 @@ class Plugin_Upgrader extends WP_Upgrader { /** * Deactivates a plugin before it is upgraded. * - * Hooked to the {@see 'upgrader_pre_install'} filter by {@see Plugin_Upgrader::upgrade()}. + * Hooked to the {@see 'upgrader_pre_install'} filter by Plugin_Upgrader::upgrade(). * * @since 2.8.0 * @since 4.1.0 Added a return value. @@ -1219,7 +1219,7 @@ class Plugin_Upgrader extends WP_Upgrader { * * @param bool|WP_Error $return Upgrade offer return. * @param array $plugin Plugin package arguments. - * @return bool|WP_Error The passed in $return param or {@see WP_Error}. + * @return bool|WP_Error The passed in $return param or WP_Error. */ public function deactivate_plugin_before_upgrade($return, $plugin) { @@ -1246,7 +1246,7 @@ class Plugin_Upgrader extends WP_Upgrader { * Delete the old plugin during an upgrade. * * Hooked to the {@see 'upgrader_clear_destination'} filter by - * {@see Plugin_Upgrader::upgrade()} and {@see Plugin_Upgrader::bulk_upgrade()}. + * Plugin_Upgrader::upgrade() and Plugin_Upgrader::bulk_upgrade(). * * @since 2.8.0 * @access public @@ -1365,7 +1365,7 @@ class Theme_Upgrader extends WP_Upgrader { /** * Check if a child theme is being installed and we need to install its parent. * - * Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::install()}. + * Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::install(). * * @since 3.4.0 * @access public @@ -1438,7 +1438,7 @@ class Theme_Upgrader extends WP_Upgrader { * Don't display the activate and preview actions to the user. * * Hooked to the {@see 'install_theme_complete_actions'} filter by - * {@see Theme_Upgrader::check_parent_theme_filter()} when installing + * Theme_Upgrader::check_parent_theme_filter() when installing * a child theme and installing the parent theme fails. * * @since 3.4.0 @@ -1467,7 +1467,7 @@ class Theme_Upgrader extends WP_Upgrader { * Default true. * } * - * @return bool|WP_Error True if the install was successful, false or a {@see WP_Error} object otherwise. + * @return bool|WP_Error True if the install was successful, false or a WP_Error object otherwise. */ public function install( $package, $args = array() ) { @@ -1522,7 +1522,7 @@ class Theme_Upgrader extends WP_Upgrader { * @type bool $clear_update_cache Whether to clear the update cache if successful. * Default true. * } - * @return bool|WP_Error True if the upgrade was successful, false or a {@see WP_Error} object otherwise. + * @return bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise. */ public function upgrade( $theme, $args = array() ) { @@ -1701,7 +1701,7 @@ class Theme_Upgrader extends WP_Upgrader { /** * Check that the package source contains a valid theme. * - * Hooked to the {@see 'upgrader_source_selection'} filter by {@see Theme_Upgrader::install()}. + * Hooked to the {@see 'upgrader_source_selection'} filter by Theme_Upgrader::install(). * It will return an error if the theme doesn't have style.css or index.php * files. * @@ -1761,8 +1761,8 @@ class Theme_Upgrader extends WP_Upgrader { /** * Turn on maintenance mode before attempting to upgrade the current theme. * - * Hooked to the {@see 'upgrader_pre_install'} filter by {@see Theme_Upgrader::upgrade()} and - * {@see Theme_Upgrader::bulk_upgrade()}. + * Hooked to the {@see 'upgrader_pre_install'} filter by Theme_Upgrader::upgrade() and + * Theme_Upgrader::bulk_upgrade(). * * @since 2.8.0 * @access public @@ -1789,8 +1789,8 @@ class Theme_Upgrader extends WP_Upgrader { /** * Turn off maintenance mode after upgrading the current theme. * - * Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::upgrade()} - * and {@see Theme_Upgrader::bulk_upgrade()}. + * Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::upgrade() + * and Theme_Upgrader::bulk_upgrade(). * * @since 2.8.0 * @access public @@ -1824,8 +1824,8 @@ class Theme_Upgrader extends WP_Upgrader { /** * Delete the old theme during an upgrade. * - * Hooked to the {@see 'upgrader_clear_destination'} filter by {@see Theme_Upgrader::upgrade()} - * and {@see Theme_Upgrader::bulk_upgrade()}. + * Hooked to the {@see 'upgrader_clear_destination'} filter by Theme_Upgrader::upgrade() + * and Theme_Upgrader::bulk_upgrade(). * * @since 2.8.0 * @access public @@ -2004,8 +2004,8 @@ class Language_Pack_Upgrader extends WP_Upgrader { * * @param string|false $update Optional. Whether an update offer is available. Default false. * @param array $args Optional. Other optional arguments, see - * {@see Language_Pack_Upgrader::bulk_upgrade()}. Default empty array. - * @return array|bool|WP_Error The result of the upgrade, or a {@see wP_Error} object instead. + * Language_Pack_Upgrader::bulk_upgrade(). Default empty array. + * @return array|bool|WP_Error The result of the upgrade, or a WP_Error object instead. */ public function upgrade( $update = false, $args = array() ) { if ( $update ) { @@ -2150,7 +2150,7 @@ class Language_Pack_Upgrader extends WP_Upgrader { * Check the package source to make sure there are .mo and .po files. * * Hooked to the {@see 'upgrader_source_selection'} filter by - * {@see Language_Pack_Upgrader::bulk_upgrade()}. + * Language_Pack_Upgrader::bulk_upgrade(). * * @since 3.7.0 * @access public diff --git a/wp-admin/includes/image-edit.php b/wp-admin/includes/image-edit.php index 8947f537a8..478a514df3 100644 --- a/wp-admin/includes/image-edit.php +++ b/wp-admin/includes/image-edit.php @@ -458,9 +458,9 @@ function _crop_image_resource($img, $x, $y, $w, $h) { * * @since 2.9.0 * - * @param WP_Image_Editor $image {@see WP_Image_Editor} instance. + * @param WP_Image_Editor $image WP_Image_Editor instance. * @param array $changes Array of change operations. - * @return WP_Image_Editor {@see WP_Image_Editor} instance with changes applied. + * @return WP_Image_Editor WP_Image_Editor instance with changes applied. */ function image_edit_apply_changes( $image, $changes ) { if ( is_resource( $image ) ) diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php index 9ef203c49c..01874a9d19 100644 --- a/wp-admin/includes/media.php +++ b/wp-admin/includes/media.php @@ -178,7 +178,7 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $ * to the image HTML when inserted into the editor. * * Passing an empty value also prevents the {@see 'image_add_caption_shortcode'} - * filter from being evaluated at the end of {@see image_add_caption()}. + * filter from being evaluated at the end of image_add_caption(). * * @since 4.1.0 * diff --git a/wp-admin/includes/ms.php b/wp-admin/includes/ms.php index a8c8808815..5464b61526 100644 --- a/wp-admin/includes/ms.php +++ b/wp-admin/includes/ms.php @@ -621,10 +621,10 @@ function format_code_lang( $code = '' ) { * @since 3.0.0 * * @param object $term The term. - * @param string $taxonomy The taxonomy for $term. Should be 'category' or 'post_tag', as these are + * @param string $taxonomy The taxonomy for `$term`. Should be 'category' or 'post_tag', as these are * the only taxonomies which are processed by this function; anything else * will be returned untouched. - * @return object|array Returns `$term`, after filtering the 'slug' field with {@see sanitize_title()} + * @return object|array Returns `$term`, after filtering the 'slug' field with sanitize_title() * if $taxonomy is 'category' or 'post_tag'. */ function sync_category_tag_slugs( $term, $taxonomy ) { diff --git a/wp-admin/includes/plugin.php b/wp-admin/includes/plugin.php index 5178c9b60c..3b29bd1af9 100644 --- a/wp-admin/includes/plugin.php +++ b/wp-admin/includes/plugin.php @@ -570,12 +570,10 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen /** * Fires as a specific plugin is being activated. * - * This hook is the "activation" hook used internally by - * {@see register_activation_hook()}. The dynamic portion of the - * hook name, `$plugin`, refers to the plugin basename. + * This hook is the "activation" hook used internally by register_activation_hook(). + * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename. * - * If a plugin is silently activated (such as during an update), - * this hook does not fire. + * If a plugin is silently activated (such as during an update), this hook does not fire. * * @since 2.0.0 * @@ -685,12 +683,10 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) { /** * Fires as a specific plugin is being deactivated. * - * This hook is the "deactivation" hook used internally by - * {@see register_deactivation_hook()}. The dynamic portion of the - * hook name, `$plugin`, refers to the plugin basename. + * This hook is the "deactivation" hook used internally by register_deactivation_hook(). + * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename. * - * If a plugin is silently deactivated (such as during an update), - * this hook does not fire. + * If a plugin is silently deactivated (such as during an update), this hook does not fire. * * @since 2.0.0 * @@ -1024,7 +1020,7 @@ function uninstall_plugin($plugin) { * Fires in uninstall_plugin() once the plugin has been uninstalled. * * The action concatenates the 'uninstall_' prefix with the basename of the - * plugin passed to {@see uninstall_plugin()} to create a dynamically-named action. + * plugin passed to uninstall_plugin() to create a dynamically-named action. * * @since 2.7.0 */ diff --git a/wp-admin/includes/revision.php b/wp-admin/includes/revision.php index 3f038f1294..4ec310fd11 100644 --- a/wp-admin/includes/revision.php +++ b/wp-admin/includes/revision.php @@ -82,12 +82,12 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) { /** * Filter revisions text diff options. * - * Filter the options passed to {@see wp_text_diff()} when viewing a post revision. + * Filter the options passed to wp_text_diff() when viewing a post revision. * * @since 4.1.0 * * @param array $args { - * Associative array of options to pass to {@see wp_text_diff()}. + * Associative array of options to pass to wp_text_diff(). * * @type bool $show_split_view True for split view (two columns), false for * un-split view (single column). Default true. diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 410c980cd2..8518a0513c 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -1428,16 +1428,16 @@ function get_settings_errors( $setting = '', $sanitize = false ) { } /** - * Display settings errors registered by {@see add_settings_error()}. + * Display settings errors registered by add_settings_error(). * * Part of the Settings API. Outputs a div for each error retrieved by - * {@see get_settings_errors()}. + * get_settings_errors(). * * This is called automatically after a settings page based on the * Settings API is submitted. Errors should be added during the validation - * callback function for a setting defined in {@see register_setting()} + * callback function for a setting defined in register_setting(). * - * The $sanitize option is passed into {@see get_settings_errors()} and will + * The $sanitize option is passed into get_settings_errors() and will * re-run the setting sanitization * on its current value. * @@ -1451,7 +1451,8 @@ function get_settings_errors( $setting = '', $sanitize = false ) { * * @param string $setting Optional slug title of a specific setting who's errors you want. * @param bool $sanitize Whether to re-sanitize the setting value before returning errors. - * @param bool $hide_on_update If set to true errors will not be shown if the settings page has already been submitted. + * @param bool $hide_on_update If set to true errors will not be shown if the settings page has + * already been submitted. */ function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) { diff --git a/wp-admin/includes/user.php b/wp-admin/includes/user.php index d92d2aebc6..f7c20c7e50 100644 --- a/wp-admin/includes/user.php +++ b/wp-admin/includes/user.php @@ -190,7 +190,7 @@ function edit_user( $user_id = 0 ) { * @since 4.4.0 * * @param int $user_id ID of the newly created user. - * @param string $notify Type of notification that should happen. See {@see wp_send_new_user_notifications()} + * @param string $notify Type of notification that should happen. See wp_send_new_user_notifications() * for more information on possible values. */ do_action( 'edit_user_created_user', $user_id, $notify ); diff --git a/wp-admin/index.php b/wp-admin/index.php index 6a33d5417a..40e74bb273 100644 --- a/wp-admin/index.php +++ b/wp-admin/index.php @@ -111,7 +111,7 @@ include( ABSPATH . 'wp-admin/admin-header.php' ); /** * Add content to the welcome panel on the admin dashboard. * - * To remove the default welcome panel, use {@see remove_action()}: + * To remove the default welcome panel, use remove_action(): * * remove_action( 'welcome_panel', 'wp_welcome_panel' ); * diff --git a/wp-includes/capabilities.php b/wp-includes/capabilities.php index 897681c34c..4b4b46787d 100644 --- a/wp-includes/capabilities.php +++ b/wp-includes/capabilities.php @@ -252,7 +252,7 @@ function map_meta_cap( $cap, $user_id ) { * Filter whether the user is allowed to add post meta to a post. * * The dynamic portion of the hook name, `$meta_key`, refers to the - * meta key passed to {@see map_meta_cap()}. + * meta key passed to map_meta_cap(). * * @since 3.3.0 * diff --git a/wp-includes/category.php b/wp-includes/category.php index a89b41065f..d2440e962b 100644 --- a/wp-includes/category.php +++ b/wp-includes/category.php @@ -17,7 +17,7 @@ * @see get_terms() Type of arguments that can be changed. * * @param string|array $args { - * Optional. Arguments to retrieve categories. See {@see get_terms()} for additional options. + * Optional. Arguments to retrieve categories. See get_terms() for additional options. * * @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'. * } @@ -30,12 +30,12 @@ function get_categories( $args = '' ) { $taxonomy = $args['taxonomy']; /** - * Filter the taxonomy used to retrieve terms when calling {@see get_categories()}. + * Filter the taxonomy used to retrieve terms when calling get_categories(). * * @since 2.7.0 * * @param string $taxonomy Taxonomy to retrieve terms from. - * @param array $args An array of arguments. See {@see get_terms()}. + * @param array $args An array of arguments. See get_terms(). */ $taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args ); diff --git a/wp-includes/class-http.php b/wp-includes/class-http.php index 838fbe8140..b0ac01ef1a 100644 --- a/wp-includes/class-http.php +++ b/wp-includes/class-http.php @@ -110,7 +110,7 @@ class WP_Http { * Default '1.0'. * @type string $user-agent User-agent value sent. * Default WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ). - * @type bool $reject_unsafe_urls Whether to pass URLs through {@see wp_http_validate_url()}. + * @type bool $reject_unsafe_urls Whether to pass URLs through wp_http_validate_url(). * Default false. * @type bool $blocking Whether the calling code requires the result of the request. * If set to false, the request will be sent to the remote server, diff --git a/wp-includes/class-wp-customize-control.php b/wp-includes/class-wp-customize-control.php index cb5ac6d540..400a0612ec 100644 --- a/wp-includes/class-wp-customize-control.php +++ b/wp-includes/class-wp-customize-control.php @@ -381,7 +381,7 @@ class WP_Customize_Control { * * @since 3.4.0 * - * @param WP_Customize_Control $this {@see WP_Customize_Control} instance. + * @param WP_Customize_Control $this WP_Customize_Control instance. */ do_action( 'customize_render_control_' . $this->id, $this ); @@ -570,7 +570,7 @@ class WP_Customize_Control { * Render the control's JS template. * * This function is only run for control types that have been registered with - * {@see WP_Customize_Manager::register_control_type()}. + * WP_Customize_Manager::register_control_type(). * * In the future, this will also print the template for the control's container * element and be override-able. @@ -589,7 +589,7 @@ class WP_Customize_Control { * An Underscore (JS) template for this control's content (but not its container). * * Class variables for this control class are available in the `data` JS object; - * export custom variables by overriding {@see WP_Customize_Control::to_json()}. + * export custom variables by overriding WP_Customize_Control::to_json(). * * @see WP_Customize_Control::print_template() * diff --git a/wp-includes/class-wp-customize-manager.php b/wp-includes/class-wp-customize-manager.php index 0f3834ae5b..0052a1ad0c 100644 --- a/wp-includes/class-wp-customize-manager.php +++ b/wp-includes/class-wp-customize-manager.php @@ -685,7 +685,7 @@ final class WP_Customize_Manager { /** * Announce when a specific setting's unsanitized post value has been set. * - * Fires when the {@see WP_Customize_Manager::set_post_value()} method is called. + * Fires when the WP_Customize_Manager::set_post_value() method is called. * * The dynamic portion of the hook name, `$setting_id`, refers to the setting ID. * @@ -699,7 +699,7 @@ final class WP_Customize_Manager { /** * Announce when any setting's unsanitized post value has been set. * - * Fires when the {@see WP_Customize_Manager::set_post_value()} method is called. + * Fires when the WP_Customize_Manager::set_post_value() method is called. * * This is useful for `WP_Customize_Setting` instances to watch * in order to update a cached previewed value. @@ -1384,7 +1384,7 @@ final class WP_Customize_Manager { * @access public * * @param string $control Name of a custom control which is a subclass of - * {@see WP_Customize_Control}. + * WP_Customize_Control. */ public function register_control_type( $control ) { $this->registered_control_types[] = $control; diff --git a/wp-includes/class-wp-customize-panel.php b/wp-includes/class-wp-customize-panel.php index d5441f6310..d00beabace 100644 --- a/wp-includes/class-wp-customize-panel.php +++ b/wp-includes/class-wp-customize-panel.php @@ -130,9 +130,9 @@ class WP_Customize_Panel { * @see WP_Customize_Section::active() * * @var callable Callback is called with one argument, the instance of - * {@see WP_Customize_Section}, and returns bool to indicate - * whether the section is active (such as it relates to the URL - * currently being previewed). + * WP_Customize_Section, and returns bool to indicate whether + * the section is active (such as it relates to the URL currently + * being previewed). */ public $active_callback = ''; @@ -183,8 +183,8 @@ class WP_Customize_Panel { * * @since 4.1.0 * - * @param bool $active Whether the Customizer panel is active. - * @param WP_Customize_Panel $panel {@see WP_Customize_Panel} instance. + * @param bool $active Whether the Customizer panel is active. + * @param WP_Customize_Panel $panel WP_Customize_Panel instance. */ $active = apply_filters( 'customize_panel_active', $active, $panel ); @@ -192,7 +192,7 @@ class WP_Customize_Panel { } /** - * Default callback used when invoking {@see WP_Customize_Panel::active()}. + * Default callback used when invoking WP_Customize_Panel::active(). * * Subclasses can override this with their specific logic, or they may * provide an 'active_callback' argument to the constructor. @@ -290,7 +290,7 @@ class WP_Customize_Panel { /** * Render the panel container, and then its contents (via `this->render_content()`) in a subclass. * - * Panel containers are now rendered in JS by default, see {@see WP_Customize_Panel::print_template()}. + * Panel containers are now rendered in JS by default, see WP_Customize_Panel::print_template(). * * @since 4.0.0 * @access protected @@ -300,7 +300,7 @@ class WP_Customize_Panel { /** * Render the panel UI in a subclass. * - * Panel contents are now rendered in JS by default, see {@see WP_Customize_Panel::print_template()}. + * Panel contents are now rendered in JS by default, see WP_Customize_Panel::print_template(). * * @since 4.1.0 * @access protected diff --git a/wp-includes/class-wp-customize-section.php b/wp-includes/class-wp-customize-section.php index 81f3ced750..5228396d00 100644 --- a/wp-includes/class-wp-customize-section.php +++ b/wp-includes/class-wp-customize-section.php @@ -139,9 +139,9 @@ class WP_Customize_Section { * @see WP_Customize_Section::active() * * @var callable Callback is called with one argument, the instance of - * {@see WP_Customize_Section}, and returns bool to indicate - * whether the section is active (such as it relates to the URL - * currently being previewed). + * WP_Customize_Section, and returns bool to indicate whether + * the section is active (such as it relates to the URL currently + * being previewed). */ public $active_callback = ''; @@ -188,12 +188,12 @@ class WP_Customize_Section { $active = call_user_func( $this->active_callback, $this ); /** - * Filter response of {@see WP_Customize_Section::active()}. + * Filter response of WP_Customize_Section::active(). * * @since 4.1.0 * * @param bool $active Whether the Customizer section is active. - * @param WP_Customize_Section $section {@see WP_Customize_Section} instance. + * @param WP_Customize_Section $section WP_Customize_Section instance. */ $active = apply_filters( 'customize_section_active', $active, $section ); @@ -201,7 +201,7 @@ class WP_Customize_Section { } /** - * Default callback used when invoking {@see WP_Customize_Section::active()}. + * Default callback used when invoking WP_Customize_Section::active(). * * Subclasses can override this with their specific logic, or they may provide * an 'active_callback' argument to the constructor. @@ -306,7 +306,7 @@ class WP_Customize_Section { /** * Render the section UI in a subclass. * - * Sections are now rendered in JS by default, see {@see WP_Customize_Section::print_template()}. + * Sections are now rendered in JS by default, see WP_Customize_Section::print_template(). * * @since 3.4.0 */ diff --git a/wp-includes/class-wp-customize-setting.php b/wp-includes/class-wp-customize-setting.php index d176d6aa2a..1e29bdd458 100644 --- a/wp-includes/class-wp-customize-setting.php +++ b/wp-includes/class-wp-customize-setting.php @@ -338,26 +338,26 @@ class WP_Customize_Setting { default : /** - * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings + * Fires when the WP_Customize_Setting::preview() method is called for settings * not handled as theme_mods or options. * * The dynamic portion of the hook name, `$this->id`, refers to the setting ID. * * @since 3.4.0 * - * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance. + * @param WP_Customize_Setting $this WP_Customize_Setting instance. */ do_action( "customize_preview_{$this->id}", $this ); /** - * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings + * Fires when the WP_Customize_Setting::preview() method is called for settings * not handled as theme_mods or options. * * The dynamic portion of the hook name, `$this->type`, refers to the setting type. * * @since 4.1.0 * - * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance. + * @param WP_Customize_Setting $this WP_Customize_Setting instance. */ do_action( "customize_preview_{$this->type}", $this ); } @@ -481,7 +481,7 @@ class WP_Customize_Setting { * * @since 3.4.0 * - * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance. + * @param WP_Customize_Setting $this WP_Customize_Setting instance. */ do_action( 'customize_save_' . $this->id_data[ 'base' ], $this ); @@ -597,7 +597,7 @@ class WP_Customize_Setting { } } else { /** - * Fires when the {@see WP_Customize_Setting::update()} method is called for settings + * Fires when the WP_Customize_Setting::update() method is called for settings * not handled as theme_mods or options. * * The dynamic portion of the hook name, `$this->type`, refers to the type of setting. @@ -687,7 +687,7 @@ class WP_Customize_Setting { * @since 3.4.0 * * @param mixed $value The setting value. - * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance. + * @param WP_Customize_Setting $this WP_Customize_Setting instance. */ $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this ); diff --git a/wp-includes/class-wp-meta-query.php b/wp-includes/class-wp-meta-query.php index 5716b5f20f..b544e4f4e6 100644 --- a/wp-includes/class-wp-meta-query.php +++ b/wp-includes/class-wp-meta-query.php @@ -12,7 +12,8 @@ * * Used for generating SQL clauses that filter a primary query according to metadata keys and values. * - * `WP_Meta_Query` is a helper that allows primary query classes, such as {@see WP_Query} and {@see WP_User_Query}, + * WP_Meta_Query is a helper that allows primary query classes, such as WP_Query and WP_User_Query, + * * to filter their results by object metadata, by generating `JOIN` and `WHERE` subclauses to be attached * to the primary SQL query string. * @@ -24,7 +25,7 @@ class WP_Meta_Query { /** * Array of metadata queries. * - * See {@see WP_Meta_Query::__construct()} for information on meta query arguments. + * See WP_Meta_Query::__construct() for information on meta query arguments. * * @since 3.2.0 * @access public @@ -360,8 +361,8 @@ class WP_Meta_Query { /** * Generate SQL clauses to be appended to a main query. * - * Called by the public {@see WP_Meta_Query::get_sql()}, this method - * is abstracted out to maintain parity with the other Query classes. + * Called by the public WP_Meta_Query::get_sql(), this method is abstracted + * out to maintain parity with the other Query classes. * * @since 4.1.0 * @access protected @@ -672,8 +673,8 @@ class WP_Meta_Query { * An existing alias is compatible if (a) it is a sibling of `$clause` * (ie, it's under the scope of the same relation), and (b) the combination * of operator and relation between the clauses allows for a shared table join. - * In the case of {@see WP_Meta_Query}, this only applies to 'IN' clauses that - * are connected by the relation 'OR'. + * In the case of WP_Meta_Query, this only applies to 'IN' clauses that are + * connected by the relation 'OR'. * * @since 4.1.0 * @access protected diff --git a/wp-includes/class-wp-tax-query.php b/wp-includes/class-wp-tax-query.php index e220806401..c77538d00a 100644 --- a/wp-includes/class-wp-tax-query.php +++ b/wp-includes/class-wp-tax-query.php @@ -24,7 +24,7 @@ class WP_Tax_Query { /** * Array of taxonomy queries. * - * See {@see WP_Tax_Query::__construct()} for information on tax query arguments. + * See WP_Tax_Query::__construct() for information on tax query arguments. * * @since 3.1.0 * @access public diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php index 92ba74fb55..967778a853 100644 --- a/wp-includes/comment-template.php +++ b/wp-includes/comment-template.php @@ -681,12 +681,13 @@ function comment_ID() { * @param array $args { * An array of optional arguments to override the defaults. * - * @type string $type Passed to {@see get_page_of_comment()}. + * @type string $type Passed to get_page_of_comment(). * @type int $page Current page of comments, for calculating comment pagination. * @type int $per_page Per-page value for comment pagination. - * @type int $max_depth Passed to {@see get_page_of_comment()}. - * @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value. If provided, this - * value overrides any value calculated from `$page` and `$per_page`. + * @type int $max_depth Passed to get_page_of_comment(). + * @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value. + * If provided, this value overrides any value calculated from `$page` + * and `$per_page`. * } * @return string The permalink to the given comment. */ diff --git a/wp-includes/comment.php b/wp-includes/comment.php index 92354d6f17..d00eb7760c 100644 --- a/wp-includes/comment.php +++ b/wp-includes/comment.php @@ -128,11 +128,10 @@ function check_comment($author, $email, $url, $comment, $user_ip, $user_agent, $ * Retrieve the approved comments for post $post_id. * * @since 2.0.0 - * @since 4.1.0 Refactored to leverage {@see WP_Comment_Query} over a direct query. + * @since 4.1.0 Refactored to leverage WP_Comment_Query over a direct query. * * @param int $post_id The ID of the post. - * @param array $args Optional. See {@see WP_Comment_Query::query()} for information - * on accepted arguments. + * @param array $args Optional. See WP_Comment_Query::query() for information on accepted arguments. * @return int|array $comments The approved comments, or number of comments if `$count` * argument is true. */ @@ -210,7 +209,7 @@ function get_comment( &$comment = null, $output = OBJECT ) { * * @since 2.7.0 * - * @param string|array $args Optional. Array or string of arguments. See {@see WP_Comment_Query::parse_query()} + * @param string|array $args Optional. Array or string of arguments. See WP_Comment_Query::parse_query() * for information on accepted arguments. Default empty. * @return int|array List of comments or number of found comments if `$count` argument is true. */ diff --git a/wp-includes/date.php b/wp-includes/date.php index ace3e41bdf..5a5eef48fb 100644 --- a/wp-includes/date.php +++ b/wp-includes/date.php @@ -2,13 +2,13 @@ /** * Class for generating SQL clauses that filter a primary query according to date. * - * `WP_Date_Query` is a helper that allows primary query classes, such as {@see WP_Query}, - * to filter their results by date columns, by generating `WHERE` subclauses to be attached - * to the primary SQL query string. + * WP_Date_Query is a helper that allows primary query classes, such as WP_Query, to filter + * their results by date columns, by generating `WHERE` subclauses to be attached to the + * primary SQL query string. * * Attempting to filter by an invalid date value (eg month=13) will generate SQL that will * return no results. In these cases, a _doing_it_wrong() error notice is also thrown. - * See {@link WP_Date_Query::validate_date_values()}. + * See WP_Date_Query::validate_date_values(). * * @link https://codex.wordpress.org/Function_Reference/WP_Query Codex page. * @@ -18,7 +18,7 @@ class WP_Date_Query { /** * Array of date queries. * - * See {@see WP_Date_Query::__construct()} for information on date query arguments. + * See WP_Date_Query::__construct() for information on date query arguments. * * @since 3.7.0 * @access public @@ -568,8 +568,8 @@ class WP_Date_Query { /** * Generate SQL clauses to be appended to a main query. * - * Called by the public {@see WP_Date_Query::get_sql()}, this method - * is abstracted out to maintain parity with the other Query classes. + * Called by the public WP_Date_Query::get_sql(), this method is abstracted + * out to maintain parity with the other Query classes. * * @since 4.1.0 * @access protected diff --git a/wp-includes/functions.php b/wp-includes/functions.php index a3d12221ac..7ce39cf9b4 100644 --- a/wp-includes/functions.php +++ b/wp-includes/functions.php @@ -1536,7 +1536,7 @@ function wp_get_referer() { /** * Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer. * - * Do not use for redirects, use {@see wp_get_referer()} instead. + * Do not use for redirects, use wp_get_referer() instead. * * @since 4.5.0 * @@ -2531,7 +2531,7 @@ function wp_nonce_ays( $action ) { * @since 4.1.0 The `$title` and `$args` parameters were changed to optionally accept * an integer to be used as the response code. * - * @param string|WP_Error $message Optional. Error message. If this is a {@see WP_Error} object, + * @param string|WP_Error $message Optional. Error message. If this is a WP_Error object, * the error's messages are used. Default empty. * @param string|int $title Optional. Error title. If `$message` is a `WP_Error` object, * error data with the key 'title' may be used to specify the title. @@ -2545,7 +2545,7 @@ function wp_nonce_ays( $action ) { * @type bool $back_link Whether to include a link to go back. Default false. * @type string $text_direction The text direction. This is only useful internally, when WordPress * is still loading and the site's locale is not set up yet. Accepts 'rtl'. - * Default is the value of {@see is_rtl()}. + * Default is the value of is_rtl(). * } */ function wp_die( $message = '', $title = '', $args = array() ) { @@ -3072,14 +3072,13 @@ function wp_send_json_success( $data = null ) { /** * Send a JSON response back to an Ajax request, indicating failure. * - * If the `$data` parameter is a {@see WP_Error} object, the errors + * If the `$data` parameter is a WP_Error object, the errors * within the object are processed and output as an array of error * codes and corresponding messages. All other types are output * without further processing. * * @since 3.5.0 - * @since 4.1.0 The `$data` parameter is now processed if a {@see WP_Error} - * object is passed in. + * @since 4.1.0 The `$data` parameter is now processed if a WP_Error object is passed in. * * @param mixed $data Data to encode as JSON, then print and die. */ diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php index 92a162ba1a..fc7058a491 100644 --- a/wp-includes/general-template.php +++ b/wp-includes/general-template.php @@ -3477,7 +3477,7 @@ function get_the_generator( $type = '' ) { * * @since 2.5.0 * - * @param string $gen The HTML markup output to {@see wp_head()}. + * @param string $gen The HTML markup output to wp_head(). * @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom', * 'rss2', 'rdf', 'comment', 'export'. */ diff --git a/wp-includes/kses.php b/wp-includes/kses.php index b16a128e22..7ac3384c51 100644 --- a/wp-includes/kses.php +++ b/wp-includes/kses.php @@ -1432,7 +1432,7 @@ function wp_kses_named_entities($matches) { /** * Callback for wp_kses_normalize_entities() regular expression. * - * This function helps {@see wp_kses_normalize_entities()} to only accept 16-bit + * This function helps wp_kses_normalize_entities() to only accept 16-bit * values and nothing more for `number;` entities. * * @access private diff --git a/wp-includes/l10n.php b/wp-includes/l10n.php index 4bfb9891f0..6a88fbbc47 100644 --- a/wp-includes/l10n.php +++ b/wp-includes/l10n.php @@ -619,7 +619,7 @@ function unload_textdomain( $domain ) { * * @since 1.5.0 * - * @param string $locale Optional. Locale to load. Default is the value of {@see get_locale()}. + * @param string $locale Optional. Locale to load. Default is the value of get_locale(). * @return bool Whether the textdomain was loaded. */ function load_default_textdomain( $locale = null ) { diff --git a/wp-includes/link-template.php b/wp-includes/link-template.php index 8a4f100e46..f192c1d7ec 100644 --- a/wp-includes/link-template.php +++ b/wp-includes/link-template.php @@ -2957,7 +2957,7 @@ function get_shortcut_link() { * Retrieves the URL for the current site where the front end is accessible. * * Returns the 'home' option with the appropriate protocol, 'https' if - * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https', + * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', * `is_ssl()` is overridden. * * @since 3.0.0 @@ -2975,9 +2975,8 @@ function home_url( $path = '', $scheme = null ) { * Retrieves the URL for a given site where the front end is accessible. * * Returns the 'home' option with the appropriate protocol, 'https' if - * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https', - * `is_ssl()` is - * overridden. + * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', + * `is_ssl()` is overridden. * * @since 3.0.0 * @@ -3051,7 +3050,7 @@ function site_url( $path = '', $scheme = null ) { * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. * * Returns the 'site_url' option with the appropriate protocol, 'https' if - * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https', + * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', * `is_ssl()` is overridden. * * @since 3.0.0 @@ -3577,7 +3576,8 @@ function rel_canonical() { * This function exists to provide a shortlink tag that all themes and plugins can target. * A plugin must hook in to provide the actual shortlinks. Default shortlink support is * limited to providing ?p= style links for posts. Plugins can short-circuit this function - * via the {@see 'pre_get_shortlink'} filter or filter the output via the {@see 'get_shortlink'} filter. + * via the {@see 'pre_get_shortlink'} filter or filter the output via the {@see 'get_shortlink'} + * filter. * * @since 3.0.0. * diff --git a/wp-includes/load.php b/wp-includes/load.php index 2f2d95b300..780613f574 100644 --- a/wp-includes/load.php +++ b/wp-includes/load.php @@ -657,7 +657,7 @@ function wp_clone( $object ) { /** * Whether the current request is for an administrative interface page. * - * Does not check if the user is an administrator; {@see current_user_can()} + * Does not check if the user is an administrator; current_user_can() * for checking roles and capabilities. * * @since 1.5.1 @@ -680,7 +680,7 @@ function is_admin() { * * e.g. `/wp-admin/` * - * Does not check if the user is an administrator; {@see current_user_can()} + * Does not check if the user is an administrator; current_user_can() * for checking roles and capabilities. * * @since 3.1.0 @@ -703,7 +703,7 @@ function is_blog_admin() { * * e.g. `/wp-admin/network/` * - * Does not check if the user is an administrator; {@see current_user_can()} + * Does not check if the user is an administrator; current_user_can() * for checking roles and capabilities. * * @since 3.1.0 @@ -728,7 +728,7 @@ function is_network_admin() { * * Does not inform on whether the user is an admin! Use capability * checks to tell if the user should be accessing a section or not - * {@see current_user_can()}. + * current_user_can(). * * @since 3.1.0 * diff --git a/wp-includes/nav-menu-template.php b/wp-includes/nav-menu-template.php index e947eb8571..7e3a36cbd2 100644 --- a/wp-includes/nav-menu-template.php +++ b/wp-includes/nav-menu-template.php @@ -104,7 +104,7 @@ class Walker_Nav_Menu extends Walker { * * @param array $classes The CSS classes that are applied to the menu item's `