enmi-conf.org: comparison wp/wp-includes/post-formats.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 /**
 * Retrieve the format slug for a post
 *
 * @since 3.1.0
 *
-* @param int|object $post Post ID or post object. Optional, default is the current post from the loop.
+* @param int|object|null $post Post ID or post object. Optional, default is the current post from the loop.
-* @return mixed The format if successful. False otherwise.
+* @return string|false The format if successful. False otherwise.
 */
 function get_post_format( $post = null ) {
 	if ( ! $post = get_post( $post ) )
 		return false;
 /**
 * Check if a post has any of the given formats, or any format.
 *
 * @since 3.1.0
 *
-* @param string|array $format Optional. The format or formats to check.
+* @param string|array    $format Optional. The format or formats to check.
-* @param object|int $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
+* @param object|int|null $post   Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
 * @return bool True if the post has any of the given formats (or any format, if no format specified), false otherwise.
 */
 function has_post_format( $format = array(), $post = null ) {
 	$prefixed = array();
 /**
 * Assign a format to a post
 *
 * @since 3.1.0
 *
-* @param int|object $post The post for which to assign a format.
+* @param int|object $post   The post for which to assign a format.
-* @param string $format A format to assign. Use an empty string or array to remove all formats from the post.
+* @param string     $format A format to assign. Use an empty string or array to remove all formats from the post.
-* @return mixed WP_Error on error. Array of affected term IDs on success.
+* @return array|WP_Error|false WP_Error on error. Array of affected term IDs on success.
 */
 function set_post_format( $post, $format ) {
 	$post = get_post( $post );
 	if ( empty( $post ) )
-		return new WP_Error( 'invalid_post', __( 'Invalid post' ) );
+		return new WP_Error( 'invalid_post', __( 'Invalid post.' ) );
 	if ( ! empty( $format ) ) {
 		$format = sanitize_key( $format );
 		if ( 'standard' === $format || ! in_array( $format, get_post_format_slugs() ) )
 			$format = '';
 	);
 	return $strings;
 }
 /**
-* Retrieves an array of post format slugs.
+* Retrieves the array of post format slugs.
 *
 * @since 3.1.0
 *
-* @return array The array of post format slugs.
+* @return array The array of post format slugs as both keys and values.
 */
 function get_post_format_slugs() {
 	$slugs = array_keys( get_post_format_strings() );
 	return array_combine( $slugs, $slugs );
 }
 * Returns a link to a post format index.
 *
 * @since 3.1.0
 *
 * @param string $format The post format slug.
-* @return string The post format term link.
+* @return string|WP_Error|false The post format term link.
 */
 function get_post_format_link( $format ) {
 	$term = get_term_by('slug', 'post-format-' . $format, 'post_format' );
 	if ( ! $term || is_wp_error( $term ) )
 		return false;
 /**
 * Filters the request to allow for the format prefix.
 *
 * @access private
 * @since 3.1.0
+*
+* @param array $qvs
+* @return array
 */
 function _post_format_request( $qvs ) {
 	if ( ! isset( $qvs['post_format'] ) )
 		return $qvs;
 	$slugs = get_post_format_slugs();
 /**
 * Filters the post format term link to remove the format prefix.
 *
 * @access private
 * @since 3.1.0
+*
+* @global WP_Rewrite $wp_rewrite
+*
+* @param string $link
+* @param object $term
+* @param string $taxonomy
+* @return string
 */
 function _post_format_link( $link, $term, $taxonomy ) {
 	global $wp_rewrite;
-	if ( 'post_format' != $taxonomy )
+	if ( 'post_format' != $taxonomy ) {
 		return $link;
+	}
 	if ( $wp_rewrite->get_extra_permastruct( $taxonomy ) ) {
 		return str_replace( "/{$term->slug}", '/' . str_replace( 'post-format-', '', $term->slug ), $link );
 	} else {
 		$link = remove_query_arg( 'post_format', $link );
 		return add_query_arg( 'post_format', str_replace( 'post-format-', '', $term->slug ), $link );
 /**
 * Remove the post format prefix from the name property of the term object created by get_term().
 *
 * @access private
 * @since 3.1.0
+*
+* @param object $term
+* @return object
 */
 function _post_format_get_term( $term ) {
 	if ( isset( $term->slug ) ) {
 		$term->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) );
 	}
 /**
 * Remove the post format prefix from the name property of the term objects created by get_terms().
 *
 * @access private
 * @since 3.1.0
+*
+* @param array        $terms
+* @param string|array $taxonomies
+* @param array        $args
+* @return array
 */
 function _post_format_get_terms( $terms, $taxonomies, $args ) {
 	if ( in_array( 'post_format', (array) $taxonomies ) ) {
 		if ( isset( $args['fields'] ) && 'names' == $args['fields'] ) {
-			foreach( $terms as $order => $name ) {
+			foreach ( $terms as $order => $name ) {
 				$terms[$order] = get_post_format_string( str_replace( 'post-format-', '', $name ) );
 			}
 		} else {
 			foreach ( (array) $terms as $order => $term ) {
 				if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) {
 /**
 * Remove the post format prefix from the name property of the term objects created by wp_get_object_terms().
 *
 * @access private
 * @since 3.1.0
+*
+* @param array $terms
+* @return array
 */
 function _post_format_wp_get_object_terms( $terms ) {
 	foreach ( (array) $terms as $order => $term ) {
 		if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) {
 			$terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) );

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9