Changeset 47060 for trunk/src/wp-includes/class-wp-rewrite.php

Timestamp:

01/11/2020 06:30:58 PM (6 years ago)

Author:

SergeyBiryukov

Message:

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

Follow-up to [46696].

See #48303.

File:

• trunk/src/wp-includes/class-wp-rewrite.php (modified) (12 diffs)

trunk/src/wp-includes/class-wp-rewrite.php

@@ -490 +490 @@
      * @since 1.5.0
      *
-     * @return string|false False on no permalink structure. Date permalink structure.
+     * @return string|false Date permalink structure on success, false on failure.
      */
     public function get_date_permastruct() {
@@ -547 +547 @@
      * @since 1.5.0
      *
-     * @return false|string False on failure. Year structure on success.
+     * @return string|false Year permalink structure on success, false on failure.
      */
     public function get_year_permastruct() {
@@ -571 +571 @@
      * @since 1.5.0
      *
-     * @return false|string False on failure. Year/Month structure on success.
+     * @return string|false Year/Month permalink structure on success, false on failure.
      */
     public function get_month_permastruct() {
@@ -593 +593 @@
      * @since 1.5.0
      *
-     * @return string|false False on failure. Year/Month/Day structure on success.
+     * @return string|false Year/Month/Day permalink structure on success, false on failure.
      */
     public function get_day_permastruct() {
@@ -609 +609 @@
      * @since 1.5.0
      *
-     * @return string|false False on failure. Category permalink structure.
+     * @return string|false Category permalink structure on success, false on failure.
      */
     public function get_category_permastruct() {
@@ -625 +625 @@
      * @since 2.3.0
      *
-     * @return string|false False on failure. Tag permalink structure.
+     * @return string|false Tag permalink structure on success, false on failure.
      */
     public function get_tag_permastruct() {
@@ -637 +637 @@
      *
      * @param string $name Permalink structure name.
-     * @return string|false False if not found. Permalink structure string.
+     * @return string|false Permalink structure string on success, false on failure.
      */
     public function get_extra_permastruct( $name ) {
@@ -660 +660 @@
      * @since 1.5.0
      *
-     * @return string|false False if not found. Permalink structure string.
+     * @return string|false Author permalink structure on success, false on failure.
      */
     public function get_author_permastruct() {
@@ -686 +686 @@
      * @since 1.5.0
      *
-     * @return string|false False if not found. Permalink structure string.
+     * @return string|false Search permalink structure on success, false on failure.
      */
     public function get_search_permastruct() {
@@ -712 +712 @@
      * @since 1.5.0
      *
-     * @return string|false False if not found. Permalink structure string.
+     * @return string|false Page permalink structure on success, false on failure.
      */
     public function get_page_permastruct() {
@@ -738 +738 @@
      * @since 1.5.0
      *
-     * @return string|false False if not found. Permalink structure string.
+     * @return string|false Feed permalink structure on success, false on failure.
      */
     public function get_feed_permastruct() {
@@ -764 +764 @@
      * @since 1.5.0
      *
-     * @return string|false False if not found. Permalink structure string.
+     * @return string|false Comment feed permalink structure on success, false on failure.
      */
     public function get_comment_feed_permastruct() {