Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2025-03-02 11:21:57 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Fix some minor DocBlock alignment issues.

Browse Source 
See #32246.
Built from https://develop.svn.wordpress.org/trunk@35885


git-svn-id: http://core.svn.wordpress.org/trunk@35849 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Pascal Birchler 2015-12-12 15:37:28 +00:00
parent e20fb91e54
commit 54b8c3e53b
10 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-admin/includes/credits.php
View File

@ -15,7 +15,7 @@
* @since 3.2.0 * @since 3.2.0
* *
* @return array|false A list of all of the contributors, or false on error. * @return array|false A list of all of the contributors, or false on error.
*/ */
function wp_credits() { function wp_credits() {
global $wp_version; global $wp_version;
$locale = get_locale(); $locale = get_locale();

2
wp-admin/includes/dashboard.php
View File

@ -1207,7 +1207,7 @@ function wp_dashboard_plugins_output( $rss, $args = array() ) {
* @since 3.0.0 * @since 3.0.0
* *
* @return bool|null True if not multisite, user can't upload files, or the space check option is disabled. * @return bool|null True if not multisite, user can't upload files, or the space check option is disabled.
*/ */
function wp_dashboard_quota() { function wp_dashboard_quota() {
if ( !is_multisite() || !current_user_can( 'upload_files' ) || get_site_option( 'upload_space_check_disabled' ) ) if ( !is_multisite() || !current_user_can( 'upload_files' ) || get_site_option( 'upload_space_check_disabled' ) )
return true; return true;

2
wp-admin/includes/file.php
View File

@ -224,7 +224,7 @@ function validate_file_to_edit( $file, $allowed_files = '' ) {
* @param string $action Expected value for $_POST['action']. * @param string $action Expected value for $_POST['action'].
* @return array On success, returns an associative array of file attributes. On failure, returns * @return array On success, returns an associative array of file attributes. On failure, returns
* $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ). * $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
*/ */
function _wp_handle_upload( &$file, $overrides, $time, $action ) { function _wp_handle_upload( &$file, $overrides, $time, $action ) {
// The default error handler. // The default error handler.
if ( ! function_exists( 'wp_handle_upload_error' ) ) { if ( ! function_exists( 'wp_handle_upload_error' ) ) {

2
wp-admin/includes/ms.php
View File

@ -1093,7 +1093,7 @@ function confirm_delete_users( $users ) {
* Print JavaScript in the header on the Network Settings screen. * Print JavaScript in the header on the Network Settings screen.
* *
* @since 4.1.0 * @since 4.1.0
*/ */
function network_settings_add_js() { function network_settings_add_js() {
?> ?>
<script type="text/javascript"> <script type="text/javascript">

2
wp-admin/includes/nav-menu.php
View File

@ -237,7 +237,7 @@ function wp_nav_menu_taxonomy_meta_boxes() {
* *
* @param int|string $nav_menu_selected_id (id, name or slug) of the currently-selected menu * @param int|string $nav_menu_selected_id (id, name or slug) of the currently-selected menu
* @return string Disabled attribute if at least one menu exists, false if not * @return string Disabled attribute if at least one menu exists, false if not
*/ */
function wp_nav_menu_disabled_check( $nav_menu_selected_id ) { function wp_nav_menu_disabled_check( $nav_menu_selected_id ) {
global $one_theme_location_no_menus; global $one_theme_location_no_menus;

4
wp-admin/includes/plugin.php
View File

@ -1350,7 +1350,7 @@ function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $fun
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
* @param callable $function The function to be called to output the content for this page. * @param callable $function The function to be called to output the content for this page.
* @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
} }
@ -1370,7 +1370,7 @@ function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $fun
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
* @param callable $function The function to be called to output the content for this page. * @param callable $function The function to be called to output the content for this page.
* @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
} }

6
wp-content/themes/twentythirteen/functions.php
View File

@ -283,9 +283,9 @@ endif;
if ( ! function_exists( 'twentythirteen_post_nav' ) ) : if ( ! function_exists( 'twentythirteen_post_nav' ) ) :
/** /**
* Display navigation to next/previous post when applicable. * Display navigation to next/previous post when applicable.
* *
* @since Twenty Thirteen 1.0 * @since Twenty Thirteen 1.0
*/ */
function twentythirteen_post_nav() { function twentythirteen_post_nav() {
global $post; global $post;

4
wp-includes/deprecated.php
View File

@ -1195,7 +1195,7 @@ function create_user($username, $password, $email) {
* Unused function. * Unused function.
* *
* @deprecated 2.5.0 * @deprecated 2.5.0
*/ */
function gzip_compression() { function gzip_compression() {
_deprecated_function( __FUNCTION__, '2.5' ); _deprecated_function( __FUNCTION__, '2.5' );
return false; return false;
@ -1613,7 +1613,7 @@ function get_the_author_ID() {
* @since 0.71 * @since 0.71
* @deprecated 2.8.0 Use the_author_meta() * @deprecated 2.8.0 Use the_author_meta()
* @see the_author_meta() * @see the_author_meta()
*/ */
function the_author_ID() { function the_author_ID() {
_deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'ID\')' ); _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'ID\')' );
the_author_meta('ID'); the_author_meta('ID');

40
wp-includes/link-template.php
View File

@ -685,7 +685,7 @@ function get_post_comments_feed_link($post_id = 0, $feed = '') {
* @param string $link_text Descriptive text. * @param string $link_text Descriptive text.
* @param int $post_id Optional post ID. Default to current post. * @param int $post_id Optional post ID. Default to current post.
* @param string $feed Optional. Feed format. * @param string $feed Optional. Feed format.
*/ */
function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) { function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
$url = get_post_comments_feed_link( $post_id, $feed ); $url = get_post_comments_feed_link( $post_id, $feed );
if ( empty( $link_text ) ) { if ( empty( $link_text ) ) {
@ -716,7 +716,7 @@ function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
* @param int $author_id ID of an author. * @param int $author_id ID of an author.
* @param string $feed Optional. Feed type. * @param string $feed Optional. Feed type.
* @return string Link to the feed for the author specified by $author_id. * @return string Link to the feed for the author specified by $author_id.
*/ */
function get_author_feed_link( $author_id, $feed = '' ) { function get_author_feed_link( $author_id, $feed = '' ) {
$author_id = (int) $author_id; $author_id = (int) $author_id;
$permalink_structure = get_option('permalink_structure'); $permalink_structure = get_option('permalink_structure');
@ -760,7 +760,7 @@ function get_author_feed_link( $author_id, $feed = '' ) {
* @param int $cat_id ID of a category. * @param int $cat_id ID of a category.
* @param string $feed Optional. Feed type. * @param string $feed Optional. Feed type.
* @return string Link to the feed for the category specified by $cat_id. * @return string Link to the feed for the category specified by $cat_id.
*/ */
function get_category_feed_link( $cat_id, $feed = '' ) { function get_category_feed_link( $cat_id, $feed = '' ) {
return get_term_feed_link( $cat_id, 'category', $feed ); return get_term_feed_link( $cat_id, 'category', $feed );
} }
@ -777,7 +777,7 @@ function get_category_feed_link( $cat_id, $feed = '' ) {
* @param string $taxonomy Optional. Taxonomy of $term_id * @param string $taxonomy Optional. Taxonomy of $term_id
* @param string $feed Optional. Feed type. * @param string $feed Optional. Feed type.
* @return string|false Link to the feed for the term specified by $term_id and $taxonomy. * @return string|false Link to the feed for the term specified by $term_id and $taxonomy.
*/ */
function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) { function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
$term_id = ( int ) $term_id; $term_id = ( int ) $term_id;
@ -2719,7 +2719,7 @@ function previous_comments_link( $label = '' ) {
* *
* @param string|array $args Optional args. See paginate_links(). * @param string|array $args Optional args. See paginate_links().
* @return string|void Markup for pagination links. * @return string|void Markup for pagination links.
*/ */
function paginate_comments_links($args = array()) { function paginate_comments_links($args = array()) {
global $wp_rewrite; global $wp_rewrite;
@ -2924,7 +2924,7 @@ function get_shortcut_link() {
* @param string|null $scheme Optional. Scheme to give the home url context. Accepts * @param string|null $scheme Optional. Scheme to give the home url context. Accepts
* 'http', 'https', 'relative', 'rest', or null. Default null. * 'http', 'https', 'relative', 'rest', or null. Default null.
* @return string Home url link with optional path appended. * @return string Home url link with optional path appended.
*/ */
function home_url( $path = '', $scheme = null ) { function home_url( $path = '', $scheme = null ) {
return get_home_url( null, $path, $scheme ); return get_home_url( null, $path, $scheme );
} }
@ -2946,7 +2946,7 @@ function home_url( $path = '', $scheme = null ) {
* @param string|null $orig_scheme Optional. Scheme to give the home URL context. Accepts * @param string|null $orig_scheme Optional. Scheme to give the home URL context. Accepts
* 'http', 'https', 'relative', 'rest', or null. Default null. * 'http', 'https', 'relative', 'rest', or null. Default null.
* @return string Home URL link with optional path appended. * @return string Home URL link with optional path appended.
*/ */
function get_home_url( $blog_id = null, $path = '', $scheme = null ) { function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
global $pagenow; global $pagenow;
@ -2998,7 +2998,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
* @param string $path Optional. Path relative to the site url. * @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme(). * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
* @return string Site url link with optional path appended. * @return string Site url link with optional path appended.
*/ */
function site_url( $path = '', $scheme = null ) { function site_url( $path = '', $scheme = null ) {
return get_site_url( null, $path, $scheme ); return get_site_url( null, $path, $scheme );
} }
@ -3018,7 +3018,7 @@ function site_url( $path = '', $scheme = null ) {
* 'http', 'https', 'login', 'login_post', 'admin', or * 'http', 'https', 'login', 'login_post', 'admin', or
* 'relative'. Default null. * 'relative'. Default null.
* @return string Site url link with optional path appended. * @return string Site url link with optional path appended.
*/ */
function get_site_url( $blog_id = null, $path = '', $scheme = null ) { function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
if ( empty( $blog_id ) || !is_multisite() ) { if ( empty( $blog_id ) || !is_multisite() ) {
$url = get_option( 'siteurl' ); $url = get_option( 'siteurl' );
@ -3055,7 +3055,7 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
* @param string $path Optional path relative to the admin url. * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes. * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended. * @return string Admin url link with optional path appended.
*/ */
function admin_url( $path = '', $scheme = 'admin' ) { function admin_url( $path = '', $scheme = 'admin' ) {
return get_admin_url( null, $path, $scheme ); return get_admin_url( null, $path, $scheme );
} }
@ -3071,7 +3071,7 @@ function admin_url( $path = '', $scheme = 'admin' ) {
* to force those schemes. Default 'admin', which obeys * to force those schemes. Default 'admin', which obeys
* {@see force_ssl_admin()} and {@see is_ssl()}. * {@see force_ssl_admin()} and {@see is_ssl()}.
* @return string Admin url link with optional path appended. * @return string Admin url link with optional path appended.
*/ */
function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) { function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
$url = get_site_url($blog_id, 'wp-admin/', $scheme); $url = get_site_url($blog_id, 'wp-admin/', $scheme);
@ -3098,7 +3098,7 @@ function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
* @param string $path Optional. Path relative to the includes url. * @param string $path Optional. Path relative to the includes url.
* @param string $scheme Optional. Scheme to give the includes url context. * @param string $scheme Optional. Scheme to give the includes url context.
* @return string Includes url link with optional path appended. * @return string Includes url link with optional path appended.
*/ */
function includes_url( $path = '', $scheme = null ) { function includes_url( $path = '', $scheme = null ) {
$url = site_url( '/' . WPINC . '/', $scheme ); $url = site_url( '/' . WPINC . '/', $scheme );
@ -3124,7 +3124,7 @@ function includes_url( $path = '', $scheme = null ) {
* *
* @param string $path Optional. Path relative to the content url. * @param string $path Optional. Path relative to the content url.
* @return string Content url link with optional path appended. * @return string Content url link with optional path appended.
*/ */
function content_url($path = '') { function content_url($path = '') {
$url = set_url_scheme( WP_CONTENT_URL ); $url = set_url_scheme( WP_CONTENT_URL );
@ -3156,7 +3156,7 @@ function content_url($path = '') {
* The URL will be relative to its directory. Default empty. * The URL will be relative to its directory. Default empty.
* Typically this is done by passing `__FILE__` as the argument. * Typically this is done by passing `__FILE__` as the argument.
* @return string Plugins URL link with optional paths appended. * @return string Plugins URL link with optional paths appended.
*/ */
function plugins_url( $path = '', $plugin = '' ) { function plugins_url( $path = '', $plugin = '' ) {
$path = wp_normalize_path( $path ); $path = wp_normalize_path( $path );
@ -3206,7 +3206,7 @@ function plugins_url( $path = '', $plugin = '' ) {
* @param string $path Optional. Path relative to the site url. * @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme(). * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
* @return string Site url link with optional path appended. * @return string Site url link with optional path appended.
*/ */
function network_site_url( $path = '', $scheme = null ) { function network_site_url( $path = '', $scheme = null ) {
if ( ! is_multisite() ) if ( ! is_multisite() )
return site_url($path, $scheme); return site_url($path, $scheme);
@ -3248,7 +3248,7 @@ function network_site_url( $path = '', $scheme = null ) {
* @param string $scheme Optional. Scheme to give the home url context. Accepts * @param string $scheme Optional. Scheme to give the home url context. Accepts
* 'http', 'https', or 'relative'. Default null. * 'http', 'https', or 'relative'. Default null.
* @return string Home url link with optional path appended. * @return string Home url link with optional path appended.
*/ */
function network_home_url( $path = '', $scheme = null ) { function network_home_url( $path = '', $scheme = null ) {
if ( ! is_multisite() ) if ( ! is_multisite() )
return home_url($path, $scheme); return home_url($path, $scheme);
@ -3289,7 +3289,7 @@ function network_home_url( $path = '', $scheme = null ) {
* @param string $path Optional path relative to the admin url. * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes. * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended. * @return string Admin url link with optional path appended.
*/ */
function network_admin_url( $path = '', $scheme = 'admin' ) { function network_admin_url( $path = '', $scheme = 'admin' ) {
if ( ! is_multisite() ) if ( ! is_multisite() )
return admin_url( $path, $scheme ); return admin_url( $path, $scheme );
@ -3319,7 +3319,7 @@ function network_admin_url( $path = '', $scheme = 'admin' ) {
* @param string $path Optional path relative to the admin url. * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes. * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended. * @return string Admin url link with optional path appended.
*/ */
function user_admin_url( $path = '', $scheme = 'admin' ) { function user_admin_url( $path = '', $scheme = 'admin' ) {
$url = network_site_url('wp-admin/user/', $scheme); $url = network_site_url('wp-admin/user/', $scheme);
@ -3346,7 +3346,7 @@ function user_admin_url( $path = '', $scheme = 'admin' ) {
* @param string $path Optional path relative to the admin url. * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes. * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended. * @return string Admin url link with optional path appended.
*/ */
function self_admin_url($path = '', $scheme = 'admin') { function self_admin_url($path = '', $scheme = 'admin') {
if ( is_network_admin() ) if ( is_network_admin() )
return network_admin_url($path, $scheme); return network_admin_url($path, $scheme);
@ -3489,7 +3489,7 @@ function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
* Output rel=canonical for singular queries. * Output rel=canonical for singular queries.
* *
* @since 2.9.0 * @since 2.9.0
*/ */
function rel_canonical() { function rel_canonical() {
if ( ! is_singular() ) { if ( ! is_singular() ) {
return; return;

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-alpha-35884'; $wp_version = '4.5-alpha-35885';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.