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.


git-svn-id: https://develop.svn.wordpress.org/trunk@37342 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-05-02 03:59:56 +00:00
parent 97dc4022c8
commit c7bed4f8c6
38 changed files with 162 additions and 169 deletions

View File

@ -125,7 +125,7 @@ class WP_List_Table {
* Default empty * Default empty
* @type bool $ajax Whether the list table supports AJAX. This includes loading * @type bool $ajax Whether the list table supports AJAX. This includes loading
* and sorting data, for example. If true, the class will call * 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. * to any scripts handling AJAX events. Default false.
* @type string $screen String containing the hook name used to determine the current * @type string $screen String containing the hook name used to determine the current
* screen. If left null, the current screen will be automatically set. * screen. If left null, the current screen will be automatically set.

View File

@ -42,9 +42,9 @@ class WP_Upgrader {
/** /**
* The result of the installation. * The result of the installation.
* *
* This is set by {@see WP_Upgrader::install_package()}, only when the package is installed * This is set by 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 * 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 * {@see 'upgrader_post_install'} filter. In that case, the WP_Error will be assigned to
* it. * it.
* *
* @since 2.8.0 * @since 2.8.0
@ -93,7 +93,7 @@ class WP_Upgrader {
* @since 2.8.0 * @since 2.8.0
* @access public * @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. * instance.
*/ */
public function __construct( $skin = null ) { public function __construct( $skin = null ) {
@ -155,11 +155,11 @@ class WP_Upgrader {
* @global WP_Filesystem_Base $wp_filesystem Subclass * @global WP_Filesystem_Base $wp_filesystem Subclass
* *
* @param array $directories Optional. A list of directories. If any of these do * @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. * Default empty array.
* @param bool $allow_relaxed_file_ownership Whether to allow relaxed file ownership. * @param bool $allow_relaxed_file_ownership Whether to allow relaxed file ownership.
* Default false. * 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 ) { public function fs_connect( $directories = array(), $allow_relaxed_file_ownership = false ) {
global $wp_filesystem; 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 * @param string $package The URI of the package. If this is the full path to an
* existing local file, it will be returned untouched. * 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 ) { public function download_package( $package ) {
@ -264,7 +264,7 @@ class WP_Upgrader {
* @param string $package Full path to the package file. * @param string $package Full path to the package file.
* @param bool $delete_package Optional. Whether to delete the package file after attempting * @param bool $delete_package Optional. Whether to delete the package file after attempting
* to unpack it. Default true. * 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 ) { public function unpack_package( $package, $delete_package = true ) {
global $wp_filesystem; global $wp_filesystem;
@ -391,10 +391,10 @@ class WP_Upgrader {
* @type bool $abort_if_destination_exists Whether to abort the installation if * @type bool $abort_if_destination_exists Whether to abort the installation if
* the destination folder already exists. Default true. * the destination folder already exists. Default true.
* @type array $hook_extra Extra arguments to pass to the filter hooks called by * @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() ) { public function install_package( $args = array() ) {
global $wp_filesystem, $wp_theme_directories; global $wp_filesystem, $wp_theme_directories;
@ -600,10 +600,10 @@ class WP_Upgrader {
* should be false. Default true. * should be false. Default true.
* @type bool $is_multi Whether this run is one of multiple upgrade/install * @type bool $is_multi Whether this run is one of multiple upgrade/install
* actions being performed in bulk. When true, the skin * 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. * aren't called. Default false.
* @type array $hook_extra Extra arguments to pass to the filter hooks called by * @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, * @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. * 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. * @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
* Default true. * 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() ) { 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. * Check a source package to be sure it contains a plugin.
* *
* This function is added to the {@see 'upgrader_source_selection'} filter by * This function is added to the {@see 'upgrader_source_selection'} filter by
* {@see Plugin_Upgrader::install()}. * Plugin_Upgrader::install().
* *
* @since 3.3.0 * @since 3.3.0
* @access public * @access public
@ -1151,7 +1151,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* @global WP_Filesystem_Base $wp_filesystem Subclass * @global WP_Filesystem_Base $wp_filesystem Subclass
* *
* @param string $source The path to the downloaded package source. * @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. * if no plugins were found.
*/ */
public function check_package($source) { public function check_package($source) {
@ -1211,7 +1211,7 @@ class Plugin_Upgrader extends WP_Upgrader {
/** /**
* Deactivates a plugin before it is upgraded. * 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 2.8.0
* @since 4.1.0 Added a return value. * @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 bool|WP_Error $return Upgrade offer return.
* @param array $plugin Plugin package arguments. * @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) { 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. * Delete the old plugin during an upgrade.
* *
* Hooked to the {@see 'upgrader_clear_destination'} filter by * 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 * @since 2.8.0
* @access public * @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. * 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 * @since 3.4.0
* @access public * @access public
@ -1438,7 +1438,7 @@ class Theme_Upgrader extends WP_Upgrader {
* Don't display the activate and preview actions to the user. * Don't display the activate and preview actions to the user.
* *
* Hooked to the {@see 'install_theme_complete_actions'} filter by * 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. * a child theme and installing the parent theme fails.
* *
* @since 3.4.0 * @since 3.4.0
@ -1467,7 +1467,7 @@ class Theme_Upgrader extends WP_Upgrader {
* Default true. * 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() ) { 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. * @type bool $clear_update_cache Whether to clear the update cache if successful.
* Default true. * 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() ) { 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. * 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 * It will return an error if the theme doesn't have style.css or index.php
* files. * files.
* *
@ -1761,8 +1761,8 @@ class Theme_Upgrader extends WP_Upgrader {
/** /**
* Turn on maintenance mode before attempting to upgrade the current theme. * 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 * Hooked to the {@see 'upgrader_pre_install'} filter by Theme_Upgrader::upgrade() and
* {@see Theme_Upgrader::bulk_upgrade()}. * Theme_Upgrader::bulk_upgrade().
* *
* @since 2.8.0 * @since 2.8.0
* @access public * @access public
@ -1789,8 +1789,8 @@ class Theme_Upgrader extends WP_Upgrader {
/** /**
* Turn off maintenance mode after upgrading the current theme. * Turn off maintenance mode after upgrading the current theme.
* *
* Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::upgrade()} * Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::upgrade()
* and {@see Theme_Upgrader::bulk_upgrade()}. * and Theme_Upgrader::bulk_upgrade().
* *
* @since 2.8.0 * @since 2.8.0
* @access public * @access public
@ -1824,8 +1824,8 @@ class Theme_Upgrader extends WP_Upgrader {
/** /**
* Delete the old theme during an upgrade. * Delete the old theme during an upgrade.
* *
* Hooked to the {@see 'upgrader_clear_destination'} filter by {@see Theme_Upgrader::upgrade()} * Hooked to the {@see 'upgrader_clear_destination'} filter by Theme_Upgrader::upgrade()
* and {@see Theme_Upgrader::bulk_upgrade()}. * and Theme_Upgrader::bulk_upgrade().
* *
* @since 2.8.0 * @since 2.8.0
* @access public * @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 string|false $update Optional. Whether an update offer is available. Default false.
* @param array $args Optional. Other optional arguments, see * @param array $args Optional. Other optional arguments, see
* {@see Language_Pack_Upgrader::bulk_upgrade()}. Default empty array. * 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. * @return array|bool|WP_Error The result of the upgrade, or a WP_Error object instead.
*/ */
public function upgrade( $update = false, $args = array() ) { public function upgrade( $update = false, $args = array() ) {
if ( $update ) { 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. * Check the package source to make sure there are .mo and .po files.
* *
* Hooked to the {@see 'upgrader_source_selection'} filter by * Hooked to the {@see 'upgrader_source_selection'} filter by
* {@see Language_Pack_Upgrader::bulk_upgrade()}. * Language_Pack_Upgrader::bulk_upgrade().
* *
* @since 3.7.0 * @since 3.7.0
* @access public * @access public

View File

@ -458,9 +458,9 @@ function _crop_image_resource($img, $x, $y, $w, $h) {
* *
* @since 2.9.0 * @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. * @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 ) { function image_edit_apply_changes( $image, $changes ) {
if ( is_resource( $image ) ) if ( is_resource( $image ) )

View File

@ -178,7 +178,7 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $
* to the image HTML when inserted into the editor. * to the image HTML when inserted into the editor.
* *
* Passing an empty value also prevents the {@see 'image_add_caption_shortcode'} * 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 * @since 4.1.0
* *

View File

@ -621,10 +621,10 @@ function format_code_lang( $code = '' ) {
* @since 3.0.0 * @since 3.0.0
* *
* @param object $term The term. * @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 * the only taxonomies which are processed by this function; anything else
* will be returned untouched. * 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'. * if $taxonomy is 'category' or 'post_tag'.
*/ */
function sync_category_tag_slugs( $term, $taxonomy ) { function sync_category_tag_slugs( $term, $taxonomy ) {

View File

@ -570,12 +570,10 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
/** /**
* Fires as a specific plugin is being activated. * Fires as a specific plugin is being activated.
* *
* This hook is the "activation" hook used internally by * This hook is the "activation" hook used internally by register_activation_hook().
* {@see register_activation_hook()}. The dynamic portion of the * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename.
* hook name, `$plugin`, refers to the plugin basename.
* *
* If a plugin is silently activated (such as during an update), * If a plugin is silently activated (such as during an update), this hook does not fire.
* this hook does not fire.
* *
* @since 2.0.0 * @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. * Fires as a specific plugin is being deactivated.
* *
* This hook is the "deactivation" hook used internally by * This hook is the "deactivation" hook used internally by register_deactivation_hook().
* {@see register_deactivation_hook()}. The dynamic portion of the * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename.
* hook name, `$plugin`, refers to the plugin basename.
* *
* If a plugin is silently deactivated (such as during an update), * If a plugin is silently deactivated (such as during an update), this hook does not fire.
* this hook does not fire.
* *
* @since 2.0.0 * @since 2.0.0
* *
@ -1024,7 +1020,7 @@ function uninstall_plugin($plugin) {
* Fires in uninstall_plugin() once the plugin has been uninstalled. * Fires in uninstall_plugin() once the plugin has been uninstalled.
* *
* The action concatenates the 'uninstall_' prefix with the basename of the * 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 * @since 2.7.0
*/ */

View File

@ -82,12 +82,12 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
/** /**
* Filter revisions text diff options. * 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 * @since 4.1.0
* *
* @param array $args { * @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 * @type bool $show_split_view True for split view (two columns), false for
* un-split view (single column). Default true. * un-split view (single column). Default true.

View File

@ -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 * 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 * This is called automatically after a settings page based on the
* Settings API is submitted. Errors should be added during the validation * 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 * re-run the setting sanitization
* on its current value. * 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 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 $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 ) { function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) {

View File

@ -190,7 +190,7 @@ function edit_user( $user_id = 0 ) {
* @since 4.4.0 * @since 4.4.0
* *
* @param int $user_id ID of the newly created user. * @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. * for more information on possible values.
*/ */
do_action( 'edit_user_created_user', $user_id, $notify ); do_action( 'edit_user_created_user', $user_id, $notify );

View File

@ -111,7 +111,7 @@ include( ABSPATH . 'wp-admin/admin-header.php' );
/** /**
* Add content to the welcome panel on the admin dashboard. * 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' ); * remove_action( 'welcome_panel', 'wp_welcome_panel' );
* *

View File

@ -252,7 +252,7 @@ function map_meta_cap( $cap, $user_id ) {
* Filter whether the user is allowed to add post meta to a post. * 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 * 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 * @since 3.3.0
* *

View File

@ -17,7 +17,7 @@
* @see get_terms() Type of arguments that can be changed. * @see get_terms() Type of arguments that can be changed.
* *
* @param string|array $args { * @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'. * @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'.
* } * }
@ -30,12 +30,12 @@ function get_categories( $args = '' ) {
$taxonomy = $args['taxonomy']; $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 * @since 2.7.0
* *
* @param string $taxonomy Taxonomy to retrieve terms from. * @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 ); $taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args );

View File

@ -110,7 +110,7 @@ class WP_Http {
* Default '1.0'. * Default '1.0'.
* @type string $user-agent User-agent value sent. * @type string $user-agent User-agent value sent.
* Default WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ). * 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. * Default false.
* @type bool $blocking Whether the calling code requires the result of the request. * @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, * If set to false, the request will be sent to the remote server,

View File

@ -381,7 +381,7 @@ class WP_Customize_Control {
* *
* @since 3.4.0 * @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 ); do_action( 'customize_render_control_' . $this->id, $this );
@ -570,7 +570,7 @@ class WP_Customize_Control {
* Render the control's JS template. * Render the control's JS template.
* *
* This function is only run for control types that have been registered with * 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 * In the future, this will also print the template for the control's container
* element and be override-able. * 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). * 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; * 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() * @see WP_Customize_Control::print_template()
* *

View File

@ -685,7 +685,7 @@ final class WP_Customize_Manager {
/** /**
* Announce when a specific setting's unsanitized post value has been set. * 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. * 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. * 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 * This is useful for `WP_Customize_Setting` instances to watch
* in order to update a cached previewed value. * in order to update a cached previewed value.
@ -1384,7 +1384,7 @@ final class WP_Customize_Manager {
* @access public * @access public
* *
* @param string $control Name of a custom control which is a subclass of * @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 ) { public function register_control_type( $control ) {
$this->registered_control_types[] = $control; $this->registered_control_types[] = $control;

View File

@ -130,9 +130,9 @@ class WP_Customize_Panel {
* @see WP_Customize_Section::active() * @see WP_Customize_Section::active()
* *
* @var callable Callback is called with one argument, the instance of * @var callable Callback is called with one argument, the instance of
* {@see WP_Customize_Section}, and returns bool to indicate * WP_Customize_Section, and returns bool to indicate whether
* whether the section is active (such as it relates to the URL * the section is active (such as it relates to the URL currently
* currently being previewed). * being previewed).
*/ */
public $active_callback = ''; public $active_callback = '';
@ -184,7 +184,7 @@ class WP_Customize_Panel {
* @since 4.1.0 * @since 4.1.0
* *
* @param bool $active Whether the Customizer panel is active. * @param bool $active Whether the Customizer panel is active.
* @param WP_Customize_Panel $panel {@see WP_Customize_Panel} instance. * @param WP_Customize_Panel $panel WP_Customize_Panel instance.
*/ */
$active = apply_filters( 'customize_panel_active', $active, $panel ); $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 * Subclasses can override this with their specific logic, or they may
* provide an 'active_callback' argument to the constructor. * 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. * 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 * @since 4.0.0
* @access protected * @access protected
@ -300,7 +300,7 @@ class WP_Customize_Panel {
/** /**
* Render the panel UI in a subclass. * 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 * @since 4.1.0
* @access protected * @access protected

View File

@ -139,9 +139,9 @@ class WP_Customize_Section {
* @see WP_Customize_Section::active() * @see WP_Customize_Section::active()
* *
* @var callable Callback is called with one argument, the instance of * @var callable Callback is called with one argument, the instance of
* {@see WP_Customize_Section}, and returns bool to indicate * WP_Customize_Section, and returns bool to indicate whether
* whether the section is active (such as it relates to the URL * the section is active (such as it relates to the URL currently
* currently being previewed). * being previewed).
*/ */
public $active_callback = ''; public $active_callback = '';
@ -188,12 +188,12 @@ class WP_Customize_Section {
$active = call_user_func( $this->active_callback, $this ); $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 * @since 4.1.0
* *
* @param bool $active Whether the Customizer section is active. * @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 ); $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 * Subclasses can override this with their specific logic, or they may provide
* an 'active_callback' argument to the constructor. * an 'active_callback' argument to the constructor.
@ -306,7 +306,7 @@ class WP_Customize_Section {
/** /**
* Render the section UI in a subclass. * 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 * @since 3.4.0
*/ */

View File

@ -338,26 +338,26 @@ class WP_Customize_Setting {
default : 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. * not handled as theme_mods or options.
* *
* The dynamic portion of the hook name, `$this->id`, refers to the setting ID. * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
* *
* @since 3.4.0 * @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 ); 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. * not handled as theme_mods or options.
* *
* The dynamic portion of the hook name, `$this->type`, refers to the setting type. * The dynamic portion of the hook name, `$this->type`, refers to the setting type.
* *
* @since 4.1.0 * @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 ); do_action( "customize_preview_{$this->type}", $this );
} }
@ -481,7 +481,7 @@ class WP_Customize_Setting {
* *
* @since 3.4.0 * @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 ); do_action( 'customize_save_' . $this->id_data[ 'base' ], $this );
@ -597,7 +597,7 @@ class WP_Customize_Setting {
} }
} else { } 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. * not handled as theme_mods or options.
* *
* The dynamic portion of the hook name, `$this->type`, refers to the type of setting. * 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 * @since 3.4.0
* *
* @param mixed $value The setting value. * @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 ); $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );

View File

@ -12,7 +12,8 @@
* *
* Used for generating SQL clauses that filter a primary query according to metadata keys and values. * 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 filter their results by object metadata, by generating `JOIN` and `WHERE` subclauses to be attached
* to the primary SQL query string. * to the primary SQL query string.
* *
@ -24,7 +25,7 @@ class WP_Meta_Query {
/** /**
* Array of metadata queries. * 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 * @since 3.2.0
* @access public * @access public
@ -360,8 +361,8 @@ class WP_Meta_Query {
/** /**
* Generate SQL clauses to be appended to a main query. * Generate SQL clauses to be appended to a main query.
* *
* Called by the public {@see WP_Meta_Query::get_sql()}, this method * Called by the public WP_Meta_Query::get_sql(), this method is abstracted
* is abstracted out to maintain parity with the other Query classes. * out to maintain parity with the other Query classes.
* *
* @since 4.1.0 * @since 4.1.0
* @access protected * @access protected
@ -672,8 +673,8 @@ class WP_Meta_Query {
* An existing alias is compatible if (a) it is a sibling of `$clause` * 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 * (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. * 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 * In the case of WP_Meta_Query, this only applies to 'IN' clauses that are
* are connected by the relation 'OR'. * connected by the relation 'OR'.
* *
* @since 4.1.0 * @since 4.1.0
* @access protected * @access protected

View File

@ -24,7 +24,7 @@ class WP_Tax_Query {
/** /**
* Array of taxonomy queries. * 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 * @since 3.1.0
* @access public * @access public

View File

@ -681,12 +681,13 @@ function comment_ID() {
* @param array $args { * @param array $args {
* An array of optional arguments to override the defaults. * 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 $page Current page of comments, for calculating comment pagination.
* @type int $per_page Per-page value for 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 $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 * @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value.
* value overrides any value calculated from `$page` and `$per_page`. * If provided, this value overrides any value calculated from `$page`
* and `$per_page`.
* } * }
* @return string The permalink to the given comment. * @return string The permalink to the given comment.
*/ */

View File

@ -128,11 +128,10 @@ function check_comment($author, $email, $url, $comment, $user_ip, $user_agent, $
* Retrieve the approved comments for post $post_id. * Retrieve the approved comments for post $post_id.
* *
* @since 2.0.0 * @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 int $post_id The ID of the post.
* @param array $args Optional. See {@see WP_Comment_Query::query()} for information * @param array $args Optional. See WP_Comment_Query::query() for information on accepted arguments.
* on accepted arguments.
* @return int|array $comments The approved comments, or number of comments if `$count` * @return int|array $comments The approved comments, or number of comments if `$count`
* argument is true. * argument is true.
*/ */
@ -210,7 +209,7 @@ function get_comment( &$comment = null, $output = OBJECT ) {
* *
* @since 2.7.0 * @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. * for information on accepted arguments. Default empty.
* @return int|array List of comments or number of found comments if `$count` argument is true. * @return int|array List of comments or number of found comments if `$count` argument is true.
*/ */

View File

@ -2,13 +2,13 @@
/** /**
* Class for generating SQL clauses that filter a primary query according to date. * 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}, * WP_Date_Query is a helper that allows primary query classes, such as WP_Query, to filter
* to filter their results by date columns, by generating `WHERE` subclauses to be attached * their results by date columns, by generating `WHERE` subclauses to be attached to the
* to the primary SQL query string. * primary SQL query string.
* *
* Attempting to filter by an invalid date value (eg month=13) will generate SQL that will * 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. * 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. * @link https://codex.wordpress.org/Function_Reference/WP_Query Codex page.
* *
@ -18,7 +18,7 @@ class WP_Date_Query {
/** /**
* Array of date queries. * 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 * @since 3.7.0
* @access public * @access public
@ -568,8 +568,8 @@ class WP_Date_Query {
/** /**
* Generate SQL clauses to be appended to a main query. * Generate SQL clauses to be appended to a main query.
* *
* Called by the public {@see WP_Date_Query::get_sql()}, this method * Called by the public WP_Date_Query::get_sql(), this method is abstracted
* is abstracted out to maintain parity with the other Query classes. * out to maintain parity with the other Query classes.
* *
* @since 4.1.0 * @since 4.1.0
* @access protected * @access protected

View File

@ -1536,7 +1536,7 @@ function wp_get_referer() {
/** /**
* Retrieves unvalidated referer from '_wp_http_referer' or HTTP 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 * @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 * @since 4.1.0 The `$title` and `$args` parameters were changed to optionally accept
* an integer to be used as the response code. * 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. * the error's messages are used. Default empty.
* @param string|int $title Optional. Error title. If `$message` is a `WP_Error` object, * @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. * 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 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 * @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'. * 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() ) { 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. * 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 * within the object are processed and output as an array of error
* codes and corresponding messages. All other types are output * codes and corresponding messages. All other types are output
* without further processing. * without further processing.
* *
* @since 3.5.0 * @since 3.5.0
* @since 4.1.0 The `$data` parameter is now processed if a {@see WP_Error} * @since 4.1.0 The `$data` parameter is now processed if a WP_Error object is passed in.
* object is passed in.
* *
* @param mixed $data Data to encode as JSON, then print and die. * @param mixed $data Data to encode as JSON, then print and die.
*/ */

View File

@ -3477,7 +3477,7 @@ function get_the_generator( $type = '' ) {
* *
* @since 2.5.0 * @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', * @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom',
* 'rss2', 'rdf', 'comment', 'export'. * 'rss2', 'rdf', 'comment', 'export'.
*/ */

View File

@ -1432,7 +1432,7 @@ function wp_kses_named_entities($matches) {
/** /**
* Callback for wp_kses_normalize_entities() regular expression. * 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. * values and nothing more for `&#number;` entities.
* *
* @access private * @access private

View File

@ -619,7 +619,7 @@ function unload_textdomain( $domain ) {
* *
* @since 1.5.0 * @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. * @return bool Whether the textdomain was loaded.
*/ */
function load_default_textdomain( $locale = null ) { function load_default_textdomain( $locale = null ) {

View File

@ -2957,7 +2957,7 @@ function get_shortcut_link() {
* Retrieves the URL for the current site where the front end is accessible. * Retrieves the URL for the current site where the front end is accessible.
* *
* Returns the 'home' option with the appropriate protocol, 'https' if * 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. * `is_ssl()` is overridden.
* *
* @since 3.0.0 * @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. * Retrieves the URL for a given site where the front end is accessible.
* *
* Returns the 'home' option with the appropriate protocol, 'https' if * 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 * `is_ssl()` is overridden.
* overridden.
* *
* @since 3.0.0 * @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. * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
* *
* Returns the 'site_url' option with the appropriate protocol, 'https' if * 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. * `is_ssl()` is overridden.
* *
* @since 3.0.0 * @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. * 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 * 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 * 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. * @since 3.0.0.
* *

View File

@ -657,7 +657,7 @@ function wp_clone( $object ) {
/** /**
* Whether the current request is for an administrative interface page. * 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. * for checking roles and capabilities.
* *
* @since 1.5.1 * @since 1.5.1
@ -680,7 +680,7 @@ function is_admin() {
* *
* e.g. `/wp-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. * for checking roles and capabilities.
* *
* @since 3.1.0 * @since 3.1.0
@ -703,7 +703,7 @@ function is_blog_admin() {
* *
* e.g. `/wp-admin/network/` * 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. * for checking roles and capabilities.
* *
* @since 3.1.0 * @since 3.1.0
@ -728,7 +728,7 @@ function is_network_admin() {
* *
* Does not inform on whether the user is an admin! Use capability * 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 * checks to tell if the user should be accessing a section or not
* {@see current_user_can()}. * current_user_can().
* *
* @since 3.1.0 * @since 3.1.0
* *

View File

@ -104,7 +104,7 @@ class Walker_Nav_Menu extends Walker {
* *
* @param array $classes The CSS classes that are applied to the menu item's `<li>` element. * @param array $classes The CSS classes that are applied to the menu item's `<li>` element.
* @param object $item The current menu item. * @param object $item The current menu item.
* @param array $args An array of {@see wp_nav_menu()} arguments. * @param array $args An array of wp_nav_menu() arguments.
* @param int $depth Depth of menu item. Used for padding. * @param int $depth Depth of menu item. Used for padding.
*/ */
$class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args, $depth ) ); $class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args, $depth ) );
@ -118,7 +118,7 @@ class Walker_Nav_Menu extends Walker {
* *
* @param string $menu_id The ID that is applied to the menu item's `<li>` element. * @param string $menu_id The ID that is applied to the menu item's `<li>` element.
* @param object $item The current menu item. * @param object $item The current menu item.
* @param array $args An array of {@see wp_nav_menu()} arguments. * @param array $args An array of wp_nav_menu() arguments.
* @param int $depth Depth of menu item. Used for padding. * @param int $depth Depth of menu item. Used for padding.
*/ */
$id = apply_filters( 'nav_menu_item_id', 'menu-item-'. $item->ID, $item, $args, $depth ); $id = apply_filters( 'nav_menu_item_id', 'menu-item-'. $item->ID, $item, $args, $depth );
@ -147,7 +147,7 @@ class Walker_Nav_Menu extends Walker {
* @type string $href The href attribute. * @type string $href The href attribute.
* } * }
* @param object $item The current menu item. * @param object $item The current menu item.
* @param array $args An array of {@see wp_nav_menu()} arguments. * @param array $args An array of wp_nav_menu() arguments.
* @param int $depth Depth of menu item. Used for padding. * @param int $depth Depth of menu item. Used for padding.
*/ */
$atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args, $depth ); $atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args, $depth );
@ -170,7 +170,7 @@ class Walker_Nav_Menu extends Walker {
* *
* @param string $title The menu item's title. * @param string $title The menu item's title.
* @param object $item The current menu item. * @param object $item The current menu item.
* @param array $args An array of {@see wp_nav_menu()} arguments. * @param array $args An array of wp_nav_menu() arguments.
* @param int $depth Depth of menu item. Used for padding. * @param int $depth Depth of menu item. Used for padding.
*/ */
$title = apply_filters( 'nav_menu_item_title', $title, $item, $args, $depth ); $title = apply_filters( 'nav_menu_item_title', $title, $item, $args, $depth );
@ -193,7 +193,7 @@ class Walker_Nav_Menu extends Walker {
* @param string $item_output The menu item's starting HTML output. * @param string $item_output The menu item's starting HTML output.
* @param object $item Menu item data object. * @param object $item Menu item data object.
* @param int $depth Depth of menu item. Used for padding. * @param int $depth Depth of menu item. Used for padding.
* @param array $args An array of {@see wp_nav_menu()} arguments. * @param array $args An array of wp_nav_menu() arguments.
*/ */
$output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args ); $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
} }

View File

@ -534,7 +534,7 @@ function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item
* @since 4.1.0 Default value of the 'orderby' argument was changed from 'none' * @since 4.1.0 Default value of the 'orderby' argument was changed from 'none'
* to 'name'. * to 'name'.
* *
* @param array $args Optional. Array of arguments passed on to {@see get_terms()}. * @param array $args Optional. Array of arguments passed on to get_terms().
* Default empty array. * Default empty array.
* @return array Menu objects. * @return array Menu objects.
*/ */
@ -611,7 +611,7 @@ function _is_valid_nav_menu_item( $item ) {
* @staticvar array $fetched * @staticvar array $fetched
* *
* @param string $menu Menu name, ID, or slug. * @param string $menu Menu name, ID, or slug.
* @param array $args Optional. Arguments to pass to {@see get_posts()}. * @param array $args Optional. Arguments to pass to get_posts().
* @return false|array $items Array of menu items, otherwise false. * @return false|array $items Array of menu items, otherwise false.
*/ */
function wp_get_nav_menu_items( $menu, $args = array() ) { function wp_get_nav_menu_items( $menu, $args = array() ) {

View File

@ -465,8 +465,7 @@ function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1)
* possible to create new action hooks by simply calling this function, * possible to create new action hooks by simply calling this function,
* specifying the name of the new hook using the `$tag` parameter. * specifying the name of the new hook using the `$tag` parameter.
* *
* You can pass extra arguments to the hooks, much like you can with * You can pass extra arguments to the hooks, much like you can with apply_filters().
* {@see apply_filters()}.
* *
* @since 1.2.0 * @since 1.2.0
* *

View File

@ -903,7 +903,7 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* Default is value of $labels['name']. * Default is value of $labels['name'].
* @type array $labels An array of labels for this post type. If not set, post * @type array $labels An array of labels for this post type. If not set, post
* labels are inherited for non-hierarchical types and page * labels are inherited for non-hierarchical types and page
* labels for hierarchical ones. {@see get_post_type_labels()}. * labels for hierarchical ones. get_post_type_labels().
* @type string $description A short descriptive summary of what the post type is. * @type string $description A short descriptive summary of what the post type is.
* Default empty. * Default empty.
* @type bool $public Whether a post type is intended for use publicly either via * @type bool $public Whether a post type is intended for use publicly either via
@ -916,7 +916,7 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* @type bool $exclude_from_search Whether to exclude posts with this post type from front end search * @type bool $exclude_from_search Whether to exclude posts with this post type from front end search
* results. Default is the opposite value of $public. * results. Default is the opposite value of $public.
* @type bool $publicly_queryable Whether queries can be performed on the front end for the post type * @type bool $publicly_queryable Whether queries can be performed on the front end for the post type
* as part of {@see parse_request()}. Endpoints would include: * as part of parse_request(). Endpoints would include:
* * ?post_type={post_type_key} * * ?post_type={post_type_key}
* * ?{post_type_key}={single_post_slug} * * ?{post_type_key}={single_post_slug}
* * ?{post_type_query_var}={single_post_slug} * * ?{post_type_query_var}={single_post_slug}
@ -947,17 +947,17 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* array('story', 'stories'). Default 'post'. * array('story', 'stories'). Default 'post'.
* @type array $capabilities Array of capabilities for this post type. $capability_type is used * @type array $capabilities Array of capabilities for this post type. $capability_type is used
* as a base to construct capabilities by default. * as a base to construct capabilities by default.
* {@see get_post_type_capabilities()}. * See get_post_type_capabilities().
* @type bool $map_meta_cap Whether to use the internal default meta capability handling. * @type bool $map_meta_cap Whether to use the internal default meta capability handling.
* Default false. * Default false.
* @type array $supports An alias for calling {@see add_post_type_support()} directly. * @type array $supports An alias for calling add_post_type_support() directly. Defaults to array
* Defaults to array containing 'title' & 'editor'. * containing 'title' & 'editor'.
* @type callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the * @type callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
* edit form. Do remove_meta_box() and add_meta_box() calls in the * edit form. Do remove_meta_box() and add_meta_box() calls in the
* callback. Default null. * callback. Default null.
* @type array $taxonomies An array of taxonomy identifiers that will be registered for the * @type array $taxonomies An array of taxonomy identifiers that will be registered for the
* post type. Taxonomies can be registered later with * post type. Taxonomies can be registered later with register_taxonomy()
* {@see register_taxonomy()} or {@see register_taxonomy_for_object_type()}. * or register_taxonomy_for_object_type().
* Default empty array. * Default empty array.
* @type bool|string $has_archive Whether there should be post type archives, or if a string, the * @type bool|string $has_archive Whether there should be post type archives, or if a string, the
* archive slug to use. Will generate the proper rewrite rules if * archive slug to use. Will generate the proper rewrite rules if
@ -5488,7 +5488,7 @@ function get_lastpostdate( $timezone = 'server', $post_type = 'any' ) {
* *
* @param string $date Date the last post was published. * @param string $date Date the last post was published.
* @param string $timezone Location to use for getting the post published date. * @param string $timezone Location to use for getting the post published date.
* See {@see get_lastpostdate()} for accepted `$timezone` values. * See get_lastpostdate() for accepted `$timezone` values.
*/ */
return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date', $post_type ), $timezone ); return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date', $post_type ), $timezone );
} }
@ -5503,7 +5503,7 @@ function get_lastpostdate( $timezone = 'server', $post_type = 'any' ) {
* @since 1.2.0 * @since 1.2.0
* @since 4.4.0 The `$post_type` argument was added. * @since 4.4.0 The `$post_type` argument was added.
* *
* @param string $timezone Optional. The timezone for the timestamp. See {@see get_lastpostdate()} * @param string $timezone Optional. The timezone for the timestamp. See get_lastpostdate()
* for information on accepted values. * for information on accepted values.
* Default 'server'. * Default 'server'.
* @param string $post_type Optional. The post type to check. Default 'any'. * @param string $post_type Optional. The post type to check. Default 'any'.
@ -5518,7 +5518,7 @@ function get_lastpostmodified( $timezone = 'server', $post_type = 'any' ) {
* @param string $lastpostmodified Date the last post was modified. * @param string $lastpostmodified Date the last post was modified.
* Returning anything other than false will short-circuit the function. * Returning anything other than false will short-circuit the function.
* @param string $timezone Location to use for getting the post modified date. * @param string $timezone Location to use for getting the post modified date.
* See {@see get_lastpostdate()} for accepted `$timezone` values. * See get_lastpostdate() for accepted `$timezone` values.
* @param string $post_type The post type to check. * @param string $post_type The post type to check.
*/ */
$lastpostmodified = apply_filters( 'pre_get_lastpostmodified', false, $timezone, $post_type ); $lastpostmodified = apply_filters( 'pre_get_lastpostmodified', false, $timezone, $post_type );
@ -5540,7 +5540,7 @@ function get_lastpostmodified( $timezone = 'server', $post_type = 'any' ) {
* *
* @param string $lastpostmodified Date the last post was modified. * @param string $lastpostmodified Date the last post was modified.
* @param string $timezone Location to use for getting the post modified date. * @param string $timezone Location to use for getting the post modified date.
* See {@see get_lastpostdate()} for accepted `$timezone` values. * See get_lastpostdate() for accepted `$timezone` values.
*/ */
return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone ); return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone );
} }
@ -5845,8 +5845,7 @@ function _transition_post_status( $new_status, $old_status, $post ) {
* *
* @param int $deprecated Not used. Can be set to null. Never implemented. Not marked * @param int $deprecated Not used. Can be set to null. Never implemented. Not marked
* as deprecated with _deprecated_argument() as it conflicts with * as deprecated with _deprecated_argument() as it conflicts with
* wp_transition_post_status() and the default filter for * wp_transition_post_status() and the default filter for _future_post_hook().
* {@see _future_post_hook()}.
* @param WP_Post $post Post object. * @param WP_Post $post Post object.
*/ */
function _future_post_hook( $deprecated, $post ) { function _future_post_hook( $deprecated, $post ) {

View File

@ -1489,7 +1489,7 @@ class WP_Query {
* @type int $comments_per_page The number of comments to return per page. * @type int $comments_per_page The number of comments to return per page.
* Default 'comments_per_page' option. * Default 'comments_per_page' option.
* @type array $date_query An associative array of WP_Date_Query arguments. * @type array $date_query An associative array of WP_Date_Query arguments.
* {@see WP_Date_Query::__construct()} * See WP_Date_Query::__construct().
* @type int $day Day of the month. Default empty. Accepts numbers 1-31. * @type int $day Day of the month. Default empty. Accepts numbers 1-31.
* @type bool $exact Whether to search by exact keyword. Default false. * @type bool $exact Whether to search by exact keyword. Default false.
* @type string|array $fields Which fields to return. Single field or all fields (string), * @type string|array $fields Which fields to return. Single field or all fields (string),
@ -1503,8 +1503,7 @@ class WP_Query {
* numbers 1-12. Default empty. * numbers 1-12. Default empty.
* @type string $meta_compare Comparison operator to test the 'meta_value'. * @type string $meta_compare Comparison operator to test the 'meta_value'.
* @type string $meta_key Custom field key. * @type string $meta_key Custom field key.
* @type array $meta_query An associative array of WP_Meta_Query arguments. * @type array $meta_query An associative array of WP_Meta_Query arguments. See WP_Meta_Query.
* {@see WP_Meta_Query}
* @type string $meta_value Custom field value. * @type string $meta_value Custom field value.
* @type int $meta_value_num Custom field value number. * @type int $meta_value_num Custom field value number.
* @type int $menu_order The menu order of the posts. * @type int $menu_order The menu order of the posts.
@ -1564,7 +1563,7 @@ class WP_Query {
* @type array $tag_slug__in An array of tag slugs (OR in). unless 'ignore_sticky_posts' is * @type array $tag_slug__in An array of tag slugs (OR in). unless 'ignore_sticky_posts' is
* true. Note: a string of comma-separated IDs will NOT work. * true. Note: a string of comma-separated IDs will NOT work.
* @type array $tax_query An associative array of WP_Tax_Query arguments. * @type array $tax_query An associative array of WP_Tax_Query arguments.
* {@see WP_Tax_Query->queries} * See WP_Tax_Query->queries.
* @type string $title Post title. * @type string $title Post title.
* @type bool $update_post_meta_cache Whether to update the post meta cache. Default true. * @type bool $update_post_meta_cache Whether to update the post meta cache. Default true.
* @type bool $update_post_term_cache Whether to update the post term cache. Default true. * @type bool $update_post_term_cache Whether to update the post term cache. Default true.

View File

@ -20,8 +20,7 @@
* does not distinguish between arguments of the same name for different request methods. * does not distinguish between arguments of the same name for different request methods.
* For instance, in a request with `GET id=1` and `POST id=2`, `$request['id']` will equal * For instance, in a request with `GET id=1` and `POST id=2`, `$request['id']` will equal
* 2 (`POST`) not 1 (`GET`). For more precision between request methods, use * 2 (`POST`) not 1 (`GET`). For more precision between request methods, use
* {@see WP_REST_Request::get_body_params()}, {@see WP_REST_Request::get_url_params()}, * WP_REST_Request::get_body_params(), WP_REST_Request::get_url_params(), etc.
* etc.
* *
* @since 4.4.0 * @since 4.4.0
* *

View File

@ -2189,7 +2189,7 @@ function sanitize_term_field($field, $value, $term_id, $taxonomy, $context) {
* @since 2.3.0 * @since 2.3.0
* *
* @param string $taxonomy Taxonomy name. * @param string $taxonomy Taxonomy name.
* @param array|string $args Optional. Array of arguments that get passed to {@see get_terms()}. * @param array|string $args Optional. Array of arguments that get passed to get_terms().
* Default empty array. * Default empty array.
* @return array|int|WP_Error Number of terms in that taxonomy or WP_Error if the taxonomy does not exist. * @return array|int|WP_Error Number of terms in that taxonomy or WP_Error if the taxonomy does not exist.
*/ */
@ -2681,7 +2681,7 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) {
* @param int|array $object_ids Object ID or array of IDs. * @param int|array $object_ids Object ID or array of IDs.
* @param string $taxonomies SQL-formatted (comma-separated and quoted) list of taxonomy names. * @param string $taxonomies SQL-formatted (comma-separated and quoted) list of taxonomy names.
* @param array $args An array of arguments for retrieving terms for the given object(s). * @param array $args An array of arguments for retrieving terms for the given object(s).
* See {@see wp_get_object_terms()} for details. * See wp_get_object_terms() for details.
*/ */
return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args ); return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );
} }
@ -2727,7 +2727,7 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) {
* @type string $slug The term slug to use. Default empty string. * @type string $slug The term slug to use. Default empty string.
* } * }
* @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`, * @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`,
* {@see WP_Error} otherwise. * WP_Error otherwise.
*/ */
function wp_insert_term( $term, $taxonomy, $args = array() ) { function wp_insert_term( $term, $taxonomy, $args = array() ) {
global $wpdb; global $wpdb;
@ -4207,7 +4207,7 @@ function _split_shared_term( $term_id, $term_taxonomy_id, $record = true ) {
} }
} }
// Keep a record of term_ids that have been split, keyed by old term_id. See {@see wp_get_split_term()}. // Keep a record of term_ids that have been split, keyed by old term_id. See wp_get_split_term().
if ( $record ) { if ( $record ) {
$split_term_data = get_option( '_split_terms', array() ); $split_term_data = get_option( '_split_terms', array() );
if ( ! isset( $split_term_data[ $term_id ] ) ) { if ( ! isset( $split_term_data[ $term_id ] ) ) {

View File

@ -542,7 +542,7 @@ function delete_user_option( $user_id, $option_name, $global = false ) {
* *
* @see WP_User_Query * @see WP_User_Query
* *
* @param array $args Optional. Arguments to retrieve users. See {@see WP_User_Query::prepare_query()} * @param array $args Optional. Arguments to retrieve users. See WP_User_Query::prepare_query().
* for more information on accepted arguments. * for more information on accepted arguments.
* @return array List of users. * @return array List of users.
*/ */
@ -967,7 +967,7 @@ function setup_userdata($for_user_id = '') {
* *
* @param array|string $args { * @param array|string $args {
* Optional. Array or string of arguments to generate a drop-down of users. * Optional. Array or string of arguments to generate a drop-down of users.
* {@see WP_User_Query::prepare_query() for additional available arguments. * See WP_User_Query::prepare_query() for additional available arguments.
* *
* @type string $show_option_all Text to show as the drop-down default (all). * @type string $show_option_all Text to show as the drop-down default (all).
* Default empty. * Default empty.
@ -1918,7 +1918,7 @@ All at ###SITENAME###
* A simpler way of inserting a user into the database. * A simpler way of inserting a user into the database.
* *
* Creates a new user with just the username, password, and email. For more * Creates a new user with just the username, password, and email. For more
* complex user creation use {@see wp_insert_user()} to specify more information. * complex user creation use wp_insert_user() to specify more information.
* *
* @since 2.0.0 * @since 2.0.0
* @see wp_insert_user() More complete way to create a new user * @see wp_insert_user() More complete way to create a new user

View File

@ -521,7 +521,7 @@ function wp_register_widget_control( $id, $name, $control_callback, $options = a
* *
* @param string $id_base The base ID of a widget created by extending WP_Widget. * @param string $id_base The base ID of a widget created by extending WP_Widget.
* @param callable $update_callback Update callback method for the widget. * @param callable $update_callback Update callback method for the widget.
* @param array $options Optional. Widget control options. See {@see wp_register_widget_control()}. * @param array $options Optional. Widget control options. See wp_register_widget_control().
* Default empty array. * Default empty array.
*/ */
function _register_widget_update_callback( $id_base, $update_callback, $options = array() ) { function _register_widget_update_callback( $id_base, $update_callback, $options = array() ) {
@ -552,7 +552,7 @@ function _register_widget_update_callback( $id_base, $update_callback, $options
* @param int|string $id Widget ID. * @param int|string $id Widget ID.
* @param string $name Name attribute for the widget. * @param string $name Name attribute for the widget.
* @param callable $form_callback Form callback. * @param callable $form_callback Form callback.
* @param array $options Optional. Widget control options. See {@see wp_register_widget_control()}. * @param array $options Optional. Widget control options. See wp_register_widget_control().
* Default empty array. * Default empty array.
*/ */
function _register_widget_form_callback($id, $name, $form_callback, $options = array()) { function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {