enmi-conf.org: comparison wp/wp-includes/query.php

equal deleted inserted replaced

-:34716fd837a4
+:be944660c56a
 * @package WordPress
 * @subpackage Query
 */
 /**
-* Retrieve variable in the WP_Query class.
+* Retrieves the value of a query variable in the WP_Query class.
 *
 * @since 1.5.0
 * @since 3.9.0 The `$default` argument was introduced.
 *
 * @global WP_Query $wp_query WordPress Query object.
 	global $wp_query;
 	return $wp_query->get( $var, $default );
 }
 /**
-* Retrieve the currently-queried object.
+* Retrieves the currently queried object.
 *
 * Wrapper for WP_Query::get_queried_object().
 *
 * @since 3.1.0
 *
 * @global WP_Query $wp_query WordPress Query object.
 *
-* @return object Queried object.
+* @return WP_Term|WP_Post_Type|WP_Post|WP_User|null The queried object.
 */
 function get_queried_object() {
 	global $wp_query;
 	return $wp_query->get_queried_object();
 }
 /**
-* Retrieve ID of the current queried object.
+* Retrieves the ID of the currently queried object.
 *
 * Wrapper for WP_Query::get_queried_object_id().
 *
 * @since 3.1.0
 *
 	global $wp_query;
 	return $wp_query->get_queried_object_id();
 }
 /**
-* Set query variable.
+* Sets the value of a query variable in the WP_Query class.
 *
 * @since 2.2.0
 *
 * @global WP_Query $wp_query WordPress Query object.
 *
 */
 /**
 * Determines whether the query is for an existing archive page.
 *
-* Month, Year, Category, Author, Post Type archive...
+* Archive pages include category, tag, author, date, custom post type,
-*
+* and custom taxonomy based archives.
-* For more information on this and similar theme functions, check out
+*
-* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
+* For more information on this and similar theme functions, check out
-* Conditional Tags} article in the Theme Developer Handbook.
+* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
-*
+* Conditional Tags} article in the Theme Developer Handbook.
-* @since 1.5.0
+*
-*
+* @since 1.5.0
+*
+* @see is_category()
+* @see is_tag()
+* @see is_author()
+* @see is_date()
+* @see is_post_type_archive()
+* @see is_tax()
 * @global WP_Query $wp_query WordPress Query object.
 *
 * @return bool Whether the query is for an existing archive page.
 */
 function is_archive() {
 *
 * For more information on this and similar theme functions, check out
 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 * Conditional Tags} article in the Theme Developer Handbook.
 *
+* @since 1.5.0
+*
 * @see is_single()
 * @see is_singular()
-*
-* @since 1.5.0
-*
 * @global WP_Query $wp_query WordPress Query object.
 *
 * @param int|string|int[]|string[] $page Optional. Page ID, title, slug, or array of such
 *                                        to check against. Default empty.
 * @return bool Whether the query is for an existing single page.
 *
 * For more information on this and similar theme functions, check out
 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 * Conditional Tags} article in the Theme Developer Handbook.
 *
+* @since 1.5.0
+*
 * @see is_page()
 * @see is_singular()
-*
-* @since 1.5.0
-*
 * @global WP_Query $wp_query WordPress Query object.
 *
 * @param int|string|int[]|string[] $post Optional. Post ID, title, slug, or array of such
 *                                        to check against. Default empty.
 * @return bool Whether the query is for an existing single post.
 *
 * For more information on this and similar theme functions, check out
 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 * Conditional Tags} article in the Theme Developer Handbook.
 *
+* @since 1.5.0
+*
 * @see is_page()
 * @see is_single()
-*
-* @since 1.5.0
-*
 * @global WP_Query $wp_query WordPress Query object.
 *
 * @param string|string[] $post_types Optional. Post type or array of post types
 *                                    to check against. Default empty.
 * @return bool Whether the query is for an existing single post
 * @global WP_Query $wp_query WordPress Query object.
 *
 * @return bool Whether the query is the main query.
 */
 function is_main_query() {
+	global $wp_query;
 	if ( 'pre_get_posts' === current_filter() ) {
-		$message = sprintf(
+		_doing_it_wrong(
-			/* translators: 1: pre_get_posts, 2: WP_Query->is_main_query(), 3: is_main_query(), 4: Link to codex is_main_query() page. */
+			__FUNCTION__,
-			__( 'In %1$s, use the %2$s method, not the %3$s function. See %4$s.' ),
+			sprintf(
-			'<code>pre_get_posts</code>',
+				/* translators: 1: pre_get_posts, 2: WP_Query->is_main_query(), 3: is_main_query(), 4: Documentation URL. */
-			'<code>WP_Query->is_main_query()</code>',
+				__( 'In %1$s, use the %2$s method, not the %3$s function. See %4$s.' ),
-			'<code>is_main_query()</code>',
+				'<code>pre_get_posts</code>',
-			__( 'https://codex.wordpress.org/Function_Reference/is_main_query' )
+				'<code>WP_Query->is_main_query()</code>',
+				'<code>is_main_query()</code>',
+				__( 'https://developer.wordpress.org/reference/functions/is_main_query/' )
+			),
+			'3.7.0'
 		);
-		_doing_it_wrong( __FUNCTION__, $message, '3.7.0' );
+	}
-	}
-	global $wp_query;
 	return $wp_query->is_main_query();
 }
 /*
 * The Loop. Post loop control.
 *
 * @since 2.2.0
 *
 * @global WP_Query $wp_query WordPress Query object.
 *
-* @return object
+* @return null
 */
 function the_comment() {
 	global $wp_query;
 	return $wp_query->the_comment();
 }
 }
 /**
 * Find the post ID for redirecting an old slug.
 *
-* @see wp_old_slug_redirect()
-*
 * @since 4.9.3
 * @access private
 *
+* @see wp_old_slug_redirect()
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param string $post_type The current post type based on the query vars.
 * @return int The Post ID.
 */
 }
 /**
 * Find the post ID for redirecting an old date.
 *
-* @see wp_old_slug_redirect()
-*
 * @since 4.9.3
 * @access private
 *
+* @see wp_old_slug_redirect()
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param string $post_type The current post type based on the query vars.
 * @return int The Post ID.
 */
 * @since 5.2.0
 *
 * @global WP_Query $wp_query WordPress Query object.
 *
 * @param WP_Post|object|int $post WP_Post instance or Post ID/object.
-* @return array|bool Elements of post, or false on failure.
+* @return array|false Elements of post, or false on failure.
 */
 function generate_postdata( $post ) {
 	global $wp_query;
 	if ( ! empty( $wp_query ) && $wp_query instanceof WP_Query ) {

changeset 18	be944660c56a
parent 16	a86126ab1dd4
child 21	48c4eec2b7e6