mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-23 01:27:36 +01:00
Docs: Correct various documentation around object
and stdClass
types.
See #37770 Built from https://develop.svn.wordpress.org/trunk@38369 git-svn-id: http://core.svn.wordpress.org/trunk@38310 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
f53cc848e4
commit
94c8ca0f2e
@ -171,7 +171,7 @@ function edit_user( $user_id = 0 ) {
|
||||
*
|
||||
* @param WP_Error &$errors WP_Error object, passed by reference.
|
||||
* @param bool $update Whether this is a user update.
|
||||
* @param WP_User &$user WP_User object, passed by reference.
|
||||
* @param stdClass &$user User object, passed by reference.
|
||||
*/
|
||||
do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );
|
||||
|
||||
|
@ -556,7 +556,7 @@ class WP_oEmbed {
|
||||
* @access private
|
||||
*
|
||||
* @param string $response_body
|
||||
* @return object|false
|
||||
* @return stdClass|false
|
||||
*/
|
||||
private function _parse_xml_body( $response_body ) {
|
||||
if ( ! function_exists( 'simplexml_import_dom' ) || ! class_exists( 'DOMDocument', false ) )
|
||||
|
@ -310,7 +310,7 @@ final class WP_Site {
|
||||
*
|
||||
* @see WP_Site::__get()
|
||||
*
|
||||
* @return object A raw site object with all details included.
|
||||
* @return stdClass A raw site object with all details included.
|
||||
*/
|
||||
private function get_details() {
|
||||
$details = wp_cache_get( $this->blog_id, 'site-details' );
|
||||
@ -347,7 +347,7 @@ final class WP_Site {
|
||||
*
|
||||
* @since 4.6.0
|
||||
*
|
||||
* @param object $details The site details.
|
||||
* @param stdClass $details The site details.
|
||||
*/
|
||||
$details = apply_filters( 'site_details', $details );
|
||||
|
||||
|
@ -176,8 +176,8 @@ function get_permalink( $post = 0, $leavename = false ) {
|
||||
*
|
||||
* @since 3.5.0
|
||||
*
|
||||
* @param stdClass $cat The category to use in the permalink.
|
||||
* @param array $cats Array of all categories associated with the post.
|
||||
* @param WP_Term $cat The category to use in the permalink.
|
||||
* @param array $cats Array of all categories (WP_Term objects) associated with the post.
|
||||
* @param WP_Post $post The post in question.
|
||||
*/
|
||||
$category_object = apply_filters( 'post_link_category', $cats[0], $cats, $post );
|
||||
|
@ -20,7 +20,7 @@ require_once ABSPATH . WPINC . '/class-walker-nav-menu.php';
|
||||
* @param array $args {
|
||||
* Optional. Array of nav menu arguments.
|
||||
*
|
||||
* @type string $menu Desired menu. Accepts (matching in order) id, slug, name. Default empty.
|
||||
* @type int|string|WP_Term $menu Desired menu. Accepts (matching in order) id, slug, name, menu object. Default empty.
|
||||
* @type string $menu_class CSS class to use for the ul element which forms the menu. Default 'menu'.
|
||||
* @type string $menu_id The ID that is applied to the ul element which forms the menu.
|
||||
* Default is the menu slug, incremented.
|
||||
|
@ -12,8 +12,8 @@
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $menu Menu ID, slug, or name - or the menu object.
|
||||
* @return object|false False if $menu param isn't supplied or term does not exist, menu object if successful.
|
||||
* @param int|string|WP_Term $menu Menu ID, slug, or name - or the menu object.
|
||||
* @return WP_Term|false False if $menu param isn't supplied or term does not exist, menu object if successful.
|
||||
*/
|
||||
function wp_get_nav_menu_object( $menu ) {
|
||||
$menu_obj = false;
|
||||
|
@ -4,7 +4,7 @@
|
||||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.7-alpha-38368';
|
||||
$wp_version = '4.7-alpha-38369';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
@ -72,7 +72,7 @@ class WP_Nav_Menu_Widget extends WP_Widget {
|
||||
* @type callable|bool $fallback_cb Callback to fire if the menu doesn't exist. Default empty.
|
||||
* @type mixed $menu Menu ID, slug, or name.
|
||||
* }
|
||||
* @param stdClass $nav_menu Nav menu object for the current menu.
|
||||
* @param WP_Term $nav_menu Nav menu object for the current menu.
|
||||
* @param array $args Display arguments for the current widget.
|
||||
* @param array $instance Array of settings for the current widget.
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user