WordPress.org

Make WordPress Core


Ignore:
Timestamp:
01/11/2020 06:30:58 PM (13 months ago)
Author:
SergeyBiryukov
Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-rewrite.php

    r47018 r47060  
    490490     * @since 1.5.0
    491491     *
    492      * @return string|false False on no permalink structure. Date permalink structure.
     492     * @return string|false Date permalink structure on success, false on failure.
    493493     */
    494494    public function get_date_permastruct() {
     
    547547     * @since 1.5.0
    548548     *
    549      * @return false|string False on failure. Year structure on success.
     549     * @return string|false Year permalink structure on success, false on failure.
    550550     */
    551551    public function get_year_permastruct() {
     
    571571     * @since 1.5.0
    572572     *
    573      * @return false|string False on failure. Year/Month structure on success.
     573     * @return string|false Year/Month permalink structure on success, false on failure.
    574574     */
    575575    public function get_month_permastruct() {
     
    593593     * @since 1.5.0
    594594     *
    595      * @return string|false False on failure. Year/Month/Day structure on success.
     595     * @return string|false Year/Month/Day permalink structure on success, false on failure.
    596596     */
    597597    public function get_day_permastruct() {
     
    609609     * @since 1.5.0
    610610     *
    611      * @return string|false False on failure. Category permalink structure.
     611     * @return string|false Category permalink structure on success, false on failure.
    612612     */
    613613    public function get_category_permastruct() {
     
    625625     * @since 2.3.0
    626626     *
    627      * @return string|false False on failure. Tag permalink structure.
     627     * @return string|false Tag permalink structure on success, false on failure.
    628628     */
    629629    public function get_tag_permastruct() {
     
    637637     *
    638638     * @param string $name Permalink structure name.
    639      * @return string|false False if not found. Permalink structure string.
     639     * @return string|false Permalink structure string on success, false on failure.
    640640     */
    641641    public function get_extra_permastruct( $name ) {
     
    660660     * @since 1.5.0
    661661     *
    662      * @return string|false False if not found. Permalink structure string.
     662     * @return string|false Author permalink structure on success, false on failure.
    663663     */
    664664    public function get_author_permastruct() {
     
    686686     * @since 1.5.0
    687687     *
    688      * @return string|false False if not found. Permalink structure string.
     688     * @return string|false Search permalink structure on success, false on failure.
    689689     */
    690690    public function get_search_permastruct() {
     
    712712     * @since 1.5.0
    713713     *
    714      * @return string|false False if not found. Permalink structure string.
     714     * @return string|false Page permalink structure on success, false on failure.
    715715     */
    716716    public function get_page_permastruct() {
     
    738738     * @since 1.5.0
    739739     *
    740      * @return string|false False if not found. Permalink structure string.
     740     * @return string|false Feed permalink structure on success, false on failure.
    741741     */
    742742    public function get_feed_permastruct() {
     
    764764     * @since 1.5.0
    765765     *
    766      * @return string|false False if not found. Permalink structure string.
     766     * @return string|false Comment feed permalink structure on success, false on failure.
    767767     */
    768768    public function get_comment_feed_permastruct() {
Note: See TracChangeset for help on using the changeset viewer.