date_create_immutable_from_format

Article About php Function Date_CreateImmutableFromFormat

Article about php function date_create_immutable_from_format

Returns a new DateTimeImmutable instance or false on failure. This function is an alias of the DateTimeImmutable::createFromFormat() method. It accepts a time string and a format string, parses the given string and returns the parsed structure.

DateTimeImmutable::getLastErrors() provides a way to query last errors that occur during date parsing. Error messages are also appended to the returned structure if an unrecognized character in the format string was encountered.

For example, if the format string includes the letter i and there are two following digits, the date_create_immutable_from_format() method will greedily read those digits as minute (i) and seconds (s). This can cause an overflow of the date portion of the structure, for instance 97 seconds overflows to 1 minute and leaves 37 seconds.

Similarly, if the format string contains the letter y and there are not enough remaining days in the year to represent that number, then the day of the week will be changed to Mon or Sun instead of Tue or Wed.

date_create_immutable_from_format example

// If this is a comment feed, check those objects too.         if ( $wp_query->is_comment_feed() && $wp_query->comment_count ) {
            // Extract the comment modified times from the comments.             $comment_times = wp_list_pluck( $wp_query->comments, 'comment_date_gmt' );

            // Add the comment times to the post times for comparison.             $modified_times = array_merge( $modified_times, $comment_times );
        }

        // Determine the maximum modified time.         $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', max( $modified_times ), $utc );
    }

    if ( false === $datetime ) {
        // Fall back to last time any post was modified or published.         $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', get_lastpostmodified( 'GMT' ), $utc );
    }

    if ( false !== $datetime ) {
        $max_modified_time = $datetime->format( $format );
    }

$time     = ( 'modified' === $field ) ? $post->post_modified_gmt : $post->post_date_gmt;
        $timezone = new DateTimeZone( 'UTC' );
    } else {
        $time     = ( 'modified' === $field ) ? $post->post_modified : $post->post_date;
        $timezone = $wp_timezone;
    }

    if ( empty( $time ) || '0000-00-00 00:00:00' === $time ) {
        return false;
    }

    $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', $time, $timezone );

    if ( false === $datetime ) {
        return false;
    }

    return $datetime->setTimezone( $wp_timezone );
}

/** * Retrieves post published or modified time as a Unix timestamp. * * Note that this function returns a true Unix timestamp, not summed with timezone offset * like older WP functions. * * @since 5.3.0 * * @param int|WP_Post $post Optional. Post ID or post object. Default is global `$post` object. * @param string $field Optional. Published or modified time to use from database. Accepts 'date' or 'modified'. * Default 'date'. * @return int|false Unix timestamp on success, false on failure. */