author | ymh <ymh.work@gmail.com> |
Fri, 05 Sep 2025 18:40:08 +0200 | |
changeset 21 | 48c4eec2b7e6 |
parent 19 | 3d72ae0968f4 |
child 22 | 8c2e4d02f4ef |
permissions | -rw-r--r-- |
0 | 1 |
<?php |
2 |
/** |
|
3 |
* WordPress Link Template Functions |
|
4 |
* |
|
5 |
* @package WordPress |
|
6 |
* @subpackage Template |
|
7 |
*/ |
|
8 |
||
9 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
10 |
* Displays the permalink for the current post. |
0 | 11 |
* |
12 |
* @since 1.2.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
13 |
* @since 4.4.0 Added the `$post` parameter. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
14 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
15 |
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. |
0 | 16 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
17 |
function the_permalink( $post = 0 ) { |
5 | 18 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
19 |
* Filters the display of the permalink for the current post. |
5 | 20 |
* |
21 |
* @since 1.5.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
22 |
* @since 4.4.0 Added the `$post` parameter. |
5 | 23 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
24 |
* @param string $permalink The permalink for the current post. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
25 |
* @param int|WP_Post $post Post ID, WP_Post object, or 0. Default 0. |
5 | 26 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
27 |
echo esc_url( apply_filters( 'the_permalink', get_permalink( $post ), $post ) ); |
0 | 28 |
} |
29 |
||
30 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
31 |
* Retrieves a trailing-slashed string if the site is set for adding trailing slashes. |
0 | 32 |
* |
33 |
* Conditionally adds a trailing slash if the permalink structure has a trailing |
|
34 |
* slash, strips the trailing slash if not. The string is passed through the |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
35 |
* {@see 'user_trailingslashit'} filter. Will remove trailing slash from string, if |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
36 |
* site is not set to have them. |
0 | 37 |
* |
38 |
* @since 2.2.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
39 |
* |
16 | 40 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
41 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
42 |
* @param string $url URL with or without a trailing slash. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
43 |
* @param string $type_of_url Optional. The type of URL being considered (e.g. single, category, etc) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
44 |
* for use in the filter. Default empty string. |
5 | 45 |
* @return string The URL with the trailing slash appended or stripped. |
0 | 46 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
47 |
function user_trailingslashit( $url, $type_of_url = '' ) { |
0 | 48 |
global $wp_rewrite; |
9 | 49 |
if ( $wp_rewrite->use_trailing_slashes ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
50 |
$url = trailingslashit( $url ); |
9 | 51 |
} else { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
52 |
$url = untrailingslashit( $url ); |
9 | 53 |
} |
0 | 54 |
|
5 | 55 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
56 |
* Filters the trailing-slashed string, depending on whether the site is set to use trailing slashes. |
5 | 57 |
* |
58 |
* @since 2.2.0 |
|
59 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
60 |
* @param string $url URL with or without a trailing slash. |
5 | 61 |
* @param string $type_of_url The type of URL being considered. Accepts 'single', 'single_trackback', |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
62 |
* 'single_feed', 'single_paged', 'commentpaged', 'paged', 'home', 'feed', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
63 |
* 'category', 'page', 'year', 'month', 'day', 'post_type_archive'. |
5 | 64 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
65 |
return apply_filters( 'user_trailingslashit', $url, $type_of_url ); |
0 | 66 |
} |
67 |
||
68 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
69 |
* Displays the permalink anchor for the current post. |
0 | 70 |
* |
71 |
* The permalink mode title will use the post title for the 'a' element 'id' |
|
72 |
* attribute. The id mode uses 'post-' with the post ID for the 'id' attribute. |
|
73 |
* |
|
74 |
* @since 0.71 |
|
75 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
76 |
* @param string $mode Optional. Permalink mode. Accepts 'title' or 'id'. Default 'id'. |
0 | 77 |
*/ |
78 |
function permalink_anchor( $mode = 'id' ) { |
|
79 |
$post = get_post(); |
|
80 |
switch ( strtolower( $mode ) ) { |
|
81 |
case 'title': |
|
82 |
$title = sanitize_title( $post->post_title ) . '-' . $post->ID; |
|
9 | 83 |
echo '<a id="' . $title . '"></a>'; |
0 | 84 |
break; |
85 |
case 'id': |
|
86 |
default: |
|
87 |
echo '<a id="post-' . $post->ID . '"></a>'; |
|
88 |
break; |
|
89 |
} |
|
90 |
} |
|
91 |
||
92 |
/** |
|
18 | 93 |
* Determine whether post should always use a plain permalink structure. |
94 |
* |
|
95 |
* @since 5.7.0 |
|
96 |
* |
|
97 |
* @param WP_Post|int|null $post Optional. Post ID or post object. Defaults to global $post. |
|
98 |
* @param bool|null $sample Optional. Whether to force consideration based on sample links. |
|
99 |
* If omitted, a sample link is generated if a post object is passed |
|
100 |
* with the filter property set to 'sample'. |
|
101 |
* @return bool Whether to use a plain permalink structure. |
|
102 |
*/ |
|
103 |
function wp_force_plain_post_permalink( $post = null, $sample = null ) { |
|
104 |
if ( |
|
105 |
null === $sample && |
|
106 |
is_object( $post ) && |
|
107 |
isset( $post->filter ) && |
|
108 |
'sample' === $post->filter |
|
109 |
) { |
|
110 |
$sample = true; |
|
111 |
} else { |
|
112 |
$post = get_post( $post ); |
|
113 |
$sample = null !== $sample ? $sample : false; |
|
114 |
} |
|
115 |
||
116 |
if ( ! $post ) { |
|
117 |
return true; |
|
118 |
} |
|
119 |
||
120 |
$post_status_obj = get_post_status_object( get_post_status( $post ) ); |
|
121 |
$post_type_obj = get_post_type_object( get_post_type( $post ) ); |
|
122 |
||
123 |
if ( ! $post_status_obj || ! $post_type_obj ) { |
|
124 |
return true; |
|
125 |
} |
|
126 |
||
127 |
if ( |
|
128 |
// Publicly viewable links never have plain permalinks. |
|
129 |
is_post_status_viewable( $post_status_obj ) || |
|
130 |
( |
|
131 |
// Private posts don't have plain permalinks if the user can read them. |
|
132 |
$post_status_obj->private && |
|
133 |
current_user_can( 'read_post', $post->ID ) |
|
134 |
) || |
|
135 |
// Protected posts don't have plain links if getting a sample URL. |
|
136 |
( $post_status_obj->protected && $sample ) |
|
137 |
) { |
|
138 |
return false; |
|
139 |
} |
|
140 |
||
141 |
return true; |
|
142 |
} |
|
143 |
||
144 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
145 |
* Retrieves the full permalink for the current post or post ID. |
0 | 146 |
* |
5 | 147 |
* This function is an alias for get_permalink(). |
148 |
* |
|
149 |
* @since 3.9.0 |
|
150 |
* |
|
151 |
* @see get_permalink() |
|
152 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
153 |
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. |
5 | 154 |
* @param bool $leavename Optional. Whether to keep post name or page name. Default false. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
155 |
* @return string|false The permalink URL. False if the post does not exist. |
5 | 156 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
157 |
function get_the_permalink( $post = 0, $leavename = false ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
158 |
return get_permalink( $post, $leavename ); |
5 | 159 |
} |
160 |
||
161 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
162 |
* Retrieves the full permalink for the current post or post ID. |
5 | 163 |
* |
0 | 164 |
* @since 1.0.0 |
165 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
166 |
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. |
5 | 167 |
* @param bool $leavename Optional. Whether to keep post name or page name. Default false. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
168 |
* @return string|false The permalink URL. False if the post does not exist. |
0 | 169 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
170 |
function get_permalink( $post = 0, $leavename = false ) { |
0 | 171 |
$rewritecode = array( |
172 |
'%year%', |
|
173 |
'%monthnum%', |
|
174 |
'%day%', |
|
175 |
'%hour%', |
|
176 |
'%minute%', |
|
177 |
'%second%', |
|
9 | 178 |
$leavename ? '' : '%postname%', |
0 | 179 |
'%post_id%', |
180 |
'%category%', |
|
181 |
'%author%', |
|
9 | 182 |
$leavename ? '' : '%pagename%', |
0 | 183 |
); |
184 |
||
16 | 185 |
if ( is_object( $post ) && isset( $post->filter ) && 'sample' === $post->filter ) { |
0 | 186 |
$sample = true; |
187 |
} else { |
|
9 | 188 |
$post = get_post( $post ); |
0 | 189 |
$sample = false; |
190 |
} |
|
191 |
||
9 | 192 |
if ( empty( $post->ID ) ) { |
0 | 193 |
return false; |
9 | 194 |
} |
195 |
||
16 | 196 |
if ( 'page' === $post->post_type ) { |
9 | 197 |
return get_page_link( $post, $leavename, $sample ); |
16 | 198 |
} elseif ( 'attachment' === $post->post_type ) { |
5 | 199 |
return get_attachment_link( $post, $leavename ); |
16 | 200 |
} elseif ( in_array( $post->post_type, get_post_types( array( '_builtin' => false ) ), true ) ) { |
9 | 201 |
return get_post_permalink( $post, $leavename, $sample ); |
202 |
} |
|
203 |
||
204 |
$permalink = get_option( 'permalink_structure' ); |
|
0 | 205 |
|
5 | 206 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
207 |
* Filters the permalink structure for a post before token replacement occurs. |
5 | 208 |
* |
209 |
* Only applies to posts with post_type of 'post'. |
|
210 |
* |
|
211 |
* @since 3.0.0 |
|
212 |
* |
|
213 |
* @param string $permalink The site's permalink structure. |
|
214 |
* @param WP_Post $post The post in question. |
|
215 |
* @param bool $leavename Whether to keep the post name. |
|
216 |
*/ |
|
217 |
$permalink = apply_filters( 'pre_post_link', $permalink, $post, $leavename ); |
|
218 |
||
18 | 219 |
if ( |
220 |
$permalink && |
|
221 |
! wp_force_plain_post_permalink( $post ) |
|
222 |
) { |
|
0 | 223 |
|
224 |
$category = ''; |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
225 |
if ( str_contains( $permalink, '%category%' ) ) { |
9 | 226 |
$cats = get_the_category( $post->ID ); |
0 | 227 |
if ( $cats ) { |
9 | 228 |
$cats = wp_list_sort( |
229 |
$cats, |
|
230 |
array( |
|
231 |
'term_id' => 'ASC', |
|
232 |
) |
|
233 |
); |
|
5 | 234 |
|
235 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
236 |
* Filters the category that gets used in the %category% permalink token. |
5 | 237 |
* |
238 |
* @since 3.5.0 |
|
239 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
240 |
* @param WP_Term $cat The category to use in the permalink. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
241 |
* @param array $cats Array of all categories (WP_Term objects) associated with the post. |
5 | 242 |
* @param WP_Post $post The post in question. |
243 |
*/ |
|
0 | 244 |
$category_object = apply_filters( 'post_link_category', $cats[0], $cats, $post ); |
5 | 245 |
|
0 | 246 |
$category_object = get_term( $category_object, 'category' ); |
9 | 247 |
$category = $category_object->slug; |
248 |
if ( $category_object->parent ) { |
|
249 |
$category = get_category_parents( $category_object->parent, false, '/', true ) . $category; |
|
250 |
} |
|
0 | 251 |
} |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
252 |
/* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
253 |
* Show default category in permalinks, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
254 |
* without having to assign it explicitly. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
255 |
*/ |
9 | 256 |
if ( empty( $category ) ) { |
0 | 257 |
$default_category = get_term( get_option( 'default_category' ), 'category' ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
258 |
if ( $default_category && ! is_wp_error( $default_category ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
259 |
$category = $default_category->slug; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
260 |
} |
0 | 261 |
} |
262 |
} |
|
263 |
||
264 |
$author = ''; |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
265 |
if ( str_contains( $permalink, '%author%' ) ) { |
9 | 266 |
$authordata = get_userdata( $post->post_author ); |
267 |
$author = $authordata->user_nicename; |
|
0 | 268 |
} |
269 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
270 |
/* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
271 |
* This is not an API call because the permalink is based on the stored post_date value, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
272 |
* which should be parsed as local time regardless of the default PHP timezone. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
273 |
*/ |
16 | 274 |
$date = explode( ' ', str_replace( array( '-', ':' ), ' ', $post->post_date ) ); |
275 |
||
276 |
$rewritereplace = array( |
|
0 | 277 |
$date[0], |
278 |
$date[1], |
|
279 |
$date[2], |
|
280 |
$date[3], |
|
281 |
$date[4], |
|
282 |
$date[5], |
|
283 |
$post->post_name, |
|
284 |
$post->ID, |
|
285 |
$category, |
|
286 |
$author, |
|
287 |
$post->post_name, |
|
288 |
); |
|
16 | 289 |
|
290 |
$permalink = home_url( str_replace( $rewritecode, $rewritereplace, $permalink ) ); |
|
291 |
$permalink = user_trailingslashit( $permalink, 'single' ); |
|
292 |
||
293 |
} else { // If they're not using the fancy permalink option. |
|
9 | 294 |
$permalink = home_url( '?p=' . $post->ID ); |
0 | 295 |
} |
5 | 296 |
|
297 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
298 |
* Filters the permalink for a post. |
5 | 299 |
* |
300 |
* Only applies to posts with post_type of 'post'. |
|
301 |
* |
|
302 |
* @since 1.5.0 |
|
303 |
* |
|
304 |
* @param string $permalink The post's permalink. |
|
305 |
* @param WP_Post $post The post in question. |
|
306 |
* @param bool $leavename Whether to keep the post name. |
|
307 |
*/ |
|
308 |
return apply_filters( 'post_link', $permalink, $post, $leavename ); |
|
0 | 309 |
} |
310 |
||
311 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
312 |
* Retrieves the permalink for a post of a custom post type. |
0 | 313 |
* |
314 |
* @since 3.0.0 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
315 |
* @since 6.1.0 Returns false if the post does not exist. |
0 | 316 |
* |
16 | 317 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
318 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
319 |
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. |
16 | 320 |
* @param bool $leavename Optional. Whether to keep post name. Default false. |
321 |
* @param bool $sample Optional. Is it a sample permalink. Default false. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
322 |
* @return string|false The post permalink URL. False if the post does not exist. |
0 | 323 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
324 |
function get_post_permalink( $post = 0, $leavename = false, $sample = false ) { |
0 | 325 |
global $wp_rewrite; |
326 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
327 |
$post = get_post( $post ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
328 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
329 |
if ( ! $post ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
330 |
return false; |
9 | 331 |
} |
332 |
||
333 |
$post_link = $wp_rewrite->get_extra_permastruct( $post->post_type ); |
|
0 | 334 |
|
335 |
$slug = $post->post_name; |
|
336 |
||
18 | 337 |
$force_plain_link = wp_force_plain_post_permalink( $post ); |
0 | 338 |
|
9 | 339 |
$post_type = get_post_type_object( $post->post_type ); |
0 | 340 |
|
5 | 341 |
if ( $post_type->hierarchical ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
342 |
$slug = get_page_uri( $post ); |
5 | 343 |
} |
344 |
||
18 | 345 |
if ( ! empty( $post_link ) && ( ! $force_plain_link || $sample ) ) { |
0 | 346 |
if ( ! $leavename ) { |
9 | 347 |
$post_link = str_replace( "%$post->post_type%", $slug, $post_link ); |
0 | 348 |
} |
9 | 349 |
$post_link = home_url( user_trailingslashit( $post_link ) ); |
0 | 350 |
} else { |
18 | 351 |
if ( $post_type->query_var && ( isset( $post->post_status ) && ! $force_plain_link ) ) { |
9 | 352 |
$post_link = add_query_arg( $post_type->query_var, $slug, '' ); |
353 |
} else { |
|
354 |
$post_link = add_query_arg( |
|
355 |
array( |
|
356 |
'post_type' => $post->post_type, |
|
357 |
'p' => $post->ID, |
|
358 |
), |
|
359 |
'' |
|
360 |
); |
|
361 |
} |
|
362 |
$post_link = home_url( $post_link ); |
|
0 | 363 |
} |
364 |
||
5 | 365 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
366 |
* Filters the permalink for a post of a custom post type. |
5 | 367 |
* |
368 |
* @since 3.0.0 |
|
369 |
* |
|
370 |
* @param string $post_link The post's permalink. |
|
371 |
* @param WP_Post $post The post in question. |
|
372 |
* @param bool $leavename Whether to keep the post name. |
|
373 |
* @param bool $sample Is it a sample permalink. |
|
374 |
*/ |
|
375 |
return apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample ); |
|
0 | 376 |
} |
377 |
||
378 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
379 |
* Retrieves the permalink for the current page or page ID. |
0 | 380 |
* |
381 |
* Respects page_on_front. Use this one. |
|
382 |
* |
|
383 |
* @since 1.5.0 |
|
384 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
385 |
* @param int|WP_Post $post Optional. Post ID or object. Default uses the global `$post`. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
386 |
* @param bool $leavename Optional. Whether to keep the page name. Default false. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
387 |
* @param bool $sample Optional. Whether it should be treated as a sample permalink. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
388 |
* Default false. |
5 | 389 |
* @return string The page permalink. |
0 | 390 |
*/ |
391 |
function get_page_link( $post = false, $leavename = false, $sample = false ) { |
|
392 |
$post = get_post( $post ); |
|
393 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
394 |
if ( 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post->ID ) { |
9 | 395 |
$link = home_url( '/' ); |
396 |
} else { |
|
0 | 397 |
$link = _get_page_link( $post, $leavename, $sample ); |
9 | 398 |
} |
0 | 399 |
|
5 | 400 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
401 |
* Filters the permalink for a page. |
5 | 402 |
* |
403 |
* @since 1.5.0 |
|
404 |
* |
|
405 |
* @param string $link The page's permalink. |
|
406 |
* @param int $post_id The ID of the page. |
|
407 |
* @param bool $sample Is it a sample permalink. |
|
408 |
*/ |
|
0 | 409 |
return apply_filters( 'page_link', $link, $post->ID, $sample ); |
410 |
} |
|
411 |
||
412 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
413 |
* Retrieves the page permalink. |
0 | 414 |
* |
415 |
* Ignores page_on_front. Internal use only. |
|
416 |
* |
|
417 |
* @since 2.1.0 |
|
418 |
* @access private |
|
419 |
* |
|
16 | 420 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
421 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
422 |
* @param int|WP_Post $post Optional. Post ID or object. Default uses the global `$post`. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
423 |
* @param bool $leavename Optional. Whether to keep the page name. Default false. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
424 |
* @param bool $sample Optional. Whether it should be treated as a sample permalink. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
425 |
* Default false. |
5 | 426 |
* @return string The page permalink. |
0 | 427 |
*/ |
428 |
function _get_page_link( $post = false, $leavename = false, $sample = false ) { |
|
429 |
global $wp_rewrite; |
|
430 |
||
431 |
$post = get_post( $post ); |
|
432 |
||
18 | 433 |
$force_plain_link = wp_force_plain_post_permalink( $post ); |
0 | 434 |
|
435 |
$link = $wp_rewrite->get_page_permastruct(); |
|
436 |
||
18 | 437 |
if ( ! empty( $link ) && ( ( isset( $post->post_status ) && ! $force_plain_link ) || $sample ) ) { |
0 | 438 |
if ( ! $leavename ) { |
9 | 439 |
$link = str_replace( '%pagename%', get_page_uri( $post ), $link ); |
0 | 440 |
} |
441 |
||
9 | 442 |
$link = home_url( $link ); |
443 |
$link = user_trailingslashit( $link, 'page' ); |
|
0 | 444 |
} else { |
445 |
$link = home_url( '?page_id=' . $post->ID ); |
|
446 |
} |
|
447 |
||
5 | 448 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
449 |
* Filters the permalink for a non-page_on_front page. |
5 | 450 |
* |
451 |
* @since 2.1.0 |
|
452 |
* |
|
453 |
* @param string $link The page's permalink. |
|
454 |
* @param int $post_id The ID of the page. |
|
455 |
*/ |
|
0 | 456 |
return apply_filters( '_get_page_link', $link, $post->ID ); |
457 |
} |
|
458 |
||
459 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
460 |
* Retrieves the permalink for an attachment. |
0 | 461 |
* |
462 |
* This can be used in the WordPress Loop or outside of it. |
|
463 |
* |
|
464 |
* @since 2.0.0 |
|
465 |
* |
|
16 | 466 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
467 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
468 |
* @param int|WP_Post $post Optional. Post ID or object. Default uses the global `$post`. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
469 |
* @param bool $leavename Optional. Whether to keep the page name. Default false. |
5 | 470 |
* @return string The attachment permalink. |
0 | 471 |
*/ |
472 |
function get_attachment_link( $post = null, $leavename = false ) { |
|
473 |
global $wp_rewrite; |
|
474 |
||
475 |
$link = false; |
|
476 |
||
18 | 477 |
$post = get_post( $post ); |
478 |
$force_plain_link = wp_force_plain_post_permalink( $post ); |
|
479 |
$parent_id = $post->post_parent; |
|
480 |
$parent = $parent_id ? get_post( $parent_id ) : false; |
|
481 |
$parent_valid = true; // Default for no parent. |
|
482 |
if ( |
|
483 |
$parent_id && |
|
484 |
( |
|
485 |
$post->post_parent === $post->ID || |
|
486 |
! $parent || |
|
487 |
! is_post_type_viewable( get_post_type( $parent ) ) |
|
488 |
) |
|
489 |
) { |
|
490 |
// Post is either its own parent or parent post unavailable. |
|
491 |
$parent_valid = false; |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
492 |
} |
0 | 493 |
|
18 | 494 |
if ( $force_plain_link || ! $parent_valid ) { |
495 |
$link = false; |
|
496 |
} elseif ( $wp_rewrite->using_permalinks() && $parent ) { |
|
16 | 497 |
if ( 'page' === $parent->post_type ) { |
498 |
$parentlink = _get_page_link( $post->post_parent ); // Ignores page_on_front. |
|
9 | 499 |
} else { |
0 | 500 |
$parentlink = get_permalink( $post->post_parent ); |
9 | 501 |
} |
502 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
503 |
if ( is_numeric( $post->post_name ) || str_contains( get_option( 'permalink_structure' ), '%category%' ) ) { |
16 | 504 |
$name = 'attachment/' . $post->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker. |
9 | 505 |
} else { |
0 | 506 |
$name = $post->post_name; |
9 | 507 |
} |
508 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
509 |
if ( ! str_contains( $parentlink, '?' ) ) { |
9 | 510 |
$link = user_trailingslashit( trailingslashit( $parentlink ) . '%postname%' ); |
511 |
} |
|
512 |
||
513 |
if ( ! $leavename ) { |
|
0 | 514 |
$link = str_replace( '%postname%', $name, $link ); |
9 | 515 |
} |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
516 |
} elseif ( $wp_rewrite->using_permalinks() && ! $leavename ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
517 |
$link = home_url( user_trailingslashit( $post->post_name ) ); |
0 | 518 |
} |
519 |
||
9 | 520 |
if ( ! $link ) { |
0 | 521 |
$link = home_url( '/?attachment_id=' . $post->ID ); |
9 | 522 |
} |
0 | 523 |
|
5 | 524 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
525 |
* Filters the permalink for an attachment. |
5 | 526 |
* |
527 |
* @since 2.0.0 |
|
18 | 528 |
* @since 5.6.0 Providing an empty string will now disable |
529 |
* the view attachment page link on the media modal. |
|
5 | 530 |
* |
531 |
* @param string $link The attachment's permalink. |
|
532 |
* @param int $post_id Attachment ID. |
|
533 |
*/ |
|
0 | 534 |
return apply_filters( 'attachment_link', $link, $post->ID ); |
535 |
} |
|
536 |
||
537 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
538 |
* Retrieves the permalink for the year archives. |
0 | 539 |
* |
540 |
* @since 1.5.0 |
|
541 |
* |
|
16 | 542 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
543 |
* |
|
544 |
* @param int|false $year Integer of year. False for current year. |
|
5 | 545 |
* @return string The permalink for the specified year archive. |
0 | 546 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
547 |
function get_year_link( $year ) { |
0 | 548 |
global $wp_rewrite; |
9 | 549 |
if ( ! $year ) { |
550 |
$year = current_time( 'Y' ); |
|
551 |
} |
|
0 | 552 |
$yearlink = $wp_rewrite->get_year_permastruct(); |
9 | 553 |
if ( ! empty( $yearlink ) ) { |
554 |
$yearlink = str_replace( '%year%', $year, $yearlink ); |
|
5 | 555 |
$yearlink = home_url( user_trailingslashit( $yearlink, 'year' ) ); |
0 | 556 |
} else { |
5 | 557 |
$yearlink = home_url( '?m=' . $year ); |
0 | 558 |
} |
5 | 559 |
|
560 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
561 |
* Filters the year archive permalink. |
5 | 562 |
* |
563 |
* @since 1.5.0 |
|
564 |
* |
|
565 |
* @param string $yearlink Permalink for the year archive. |
|
566 |
* @param int $year Year for the archive. |
|
567 |
*/ |
|
568 |
return apply_filters( 'year_link', $yearlink, $year ); |
|
0 | 569 |
} |
570 |
||
571 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
572 |
* Retrieves the permalink for the month archives with year. |
0 | 573 |
* |
574 |
* @since 1.0.0 |
|
575 |
* |
|
16 | 576 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
577 |
* |
|
578 |
* @param int|false $year Integer of year. False for current year. |
|
579 |
* @param int|false $month Integer of month. False for current month. |
|
5 | 580 |
* @return string The permalink for the specified month and year archive. |
0 | 581 |
*/ |
9 | 582 |
function get_month_link( $year, $month ) { |
0 | 583 |
global $wp_rewrite; |
9 | 584 |
if ( ! $year ) { |
585 |
$year = current_time( 'Y' ); |
|
586 |
} |
|
587 |
if ( ! $month ) { |
|
588 |
$month = current_time( 'm' ); |
|
589 |
} |
|
0 | 590 |
$monthlink = $wp_rewrite->get_month_permastruct(); |
9 | 591 |
if ( ! empty( $monthlink ) ) { |
592 |
$monthlink = str_replace( '%year%', $year, $monthlink ); |
|
18 | 593 |
$monthlink = str_replace( '%monthnum%', zeroise( (int) $month, 2 ), $monthlink ); |
5 | 594 |
$monthlink = home_url( user_trailingslashit( $monthlink, 'month' ) ); |
0 | 595 |
} else { |
5 | 596 |
$monthlink = home_url( '?m=' . $year . zeroise( $month, 2 ) ); |
0 | 597 |
} |
5 | 598 |
|
599 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
600 |
* Filters the month archive permalink. |
5 | 601 |
* |
602 |
* @since 1.5.0 |
|
603 |
* |
|
604 |
* @param string $monthlink Permalink for the month archive. |
|
605 |
* @param int $year Year for the archive. |
|
606 |
* @param int $month The month for the archive. |
|
607 |
*/ |
|
608 |
return apply_filters( 'month_link', $monthlink, $year, $month ); |
|
0 | 609 |
} |
610 |
||
611 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
612 |
* Retrieves the permalink for the day archives with year and month. |
0 | 613 |
* |
614 |
* @since 1.0.0 |
|
615 |
* |
|
16 | 616 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
617 |
* |
|
618 |
* @param int|false $year Integer of year. False for current year. |
|
619 |
* @param int|false $month Integer of month. False for current month. |
|
620 |
* @param int|false $day Integer of day. False for current day. |
|
5 | 621 |
* @return string The permalink for the specified day, month, and year archive. |
0 | 622 |
*/ |
9 | 623 |
function get_day_link( $year, $month, $day ) { |
0 | 624 |
global $wp_rewrite; |
9 | 625 |
if ( ! $year ) { |
626 |
$year = current_time( 'Y' ); |
|
627 |
} |
|
628 |
if ( ! $month ) { |
|
629 |
$month = current_time( 'm' ); |
|
630 |
} |
|
631 |
if ( ! $day ) { |
|
632 |
$day = current_time( 'j' ); |
|
633 |
} |
|
0 | 634 |
|
635 |
$daylink = $wp_rewrite->get_day_permastruct(); |
|
9 | 636 |
if ( ! empty( $daylink ) ) { |
637 |
$daylink = str_replace( '%year%', $year, $daylink ); |
|
18 | 638 |
$daylink = str_replace( '%monthnum%', zeroise( (int) $month, 2 ), $daylink ); |
639 |
$daylink = str_replace( '%day%', zeroise( (int) $day, 2 ), $daylink ); |
|
5 | 640 |
$daylink = home_url( user_trailingslashit( $daylink, 'day' ) ); |
0 | 641 |
} else { |
5 | 642 |
$daylink = home_url( '?m=' . $year . zeroise( $month, 2 ) . zeroise( $day, 2 ) ); |
0 | 643 |
} |
5 | 644 |
|
645 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
646 |
* Filters the day archive permalink. |
5 | 647 |
* |
648 |
* @since 1.5.0 |
|
649 |
* |
|
650 |
* @param string $daylink Permalink for the day archive. |
|
651 |
* @param int $year Year for the archive. |
|
652 |
* @param int $month Month for the archive. |
|
653 |
* @param int $day The day for the archive. |
|
654 |
*/ |
|
655 |
return apply_filters( 'day_link', $daylink, $year, $month, $day ); |
|
0 | 656 |
} |
657 |
||
658 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
659 |
* Displays the permalink for the feed type. |
0 | 660 |
* |
661 |
* @since 3.0.0 |
|
662 |
* |
|
663 |
* @param string $anchor The link's anchor text. |
|
16 | 664 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
665 |
* Default is the value of get_default_feed(). |
|
0 | 666 |
*/ |
667 |
function the_feed_link( $anchor, $feed = '' ) { |
|
668 |
$link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>'; |
|
5 | 669 |
|
670 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
671 |
* Filters the feed link anchor tag. |
5 | 672 |
* |
673 |
* @since 3.0.0 |
|
674 |
* |
|
675 |
* @param string $link The complete anchor tag for a feed link. |
|
16 | 676 |
* @param string $feed The feed type. Possible values include 'rss2', 'atom', |
677 |
* or an empty string for the default feed type. |
|
5 | 678 |
*/ |
0 | 679 |
echo apply_filters( 'the_feed_link', $link, $feed ); |
680 |
} |
|
681 |
||
682 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
683 |
* Retrieves the permalink for the feed type. |
0 | 684 |
* |
685 |
* @since 1.5.0 |
|
686 |
* |
|
16 | 687 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
688 |
* |
|
689 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
|
690 |
* Default is the value of get_default_feed(). |
|
5 | 691 |
* @return string The feed permalink. |
0 | 692 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
693 |
function get_feed_link( $feed = '' ) { |
0 | 694 |
global $wp_rewrite; |
695 |
||
696 |
$permalink = $wp_rewrite->get_feed_permastruct(); |
|
16 | 697 |
|
18 | 698 |
if ( $permalink ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
699 |
if ( str_contains( $feed, 'comments_' ) ) { |
9 | 700 |
$feed = str_replace( 'comments_', '', $feed ); |
0 | 701 |
$permalink = $wp_rewrite->get_comment_feed_permastruct(); |
702 |
} |
|
703 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
704 |
if ( get_default_feed() === $feed ) { |
0 | 705 |
$feed = ''; |
9 | 706 |
} |
707 |
||
708 |
$permalink = str_replace( '%feed%', $feed, $permalink ); |
|
709 |
$permalink = preg_replace( '#/+#', '/', "/$permalink" ); |
|
710 |
$output = home_url( user_trailingslashit( $permalink, 'feed' ) ); |
|
0 | 711 |
} else { |
9 | 712 |
if ( empty( $feed ) ) { |
0 | 713 |
$feed = get_default_feed(); |
9 | 714 |
} |
715 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
716 |
if ( str_contains( $feed, 'comments_' ) ) { |
9 | 717 |
$feed = str_replace( 'comments_', 'comments-', $feed ); |
718 |
} |
|
719 |
||
720 |
$output = home_url( "?feed={$feed}" ); |
|
0 | 721 |
} |
722 |
||
5 | 723 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
724 |
* Filters the feed type permalink. |
5 | 725 |
* |
726 |
* @since 1.5.0 |
|
727 |
* |
|
728 |
* @param string $output The feed permalink. |
|
16 | 729 |
* @param string $feed The feed type. Possible values include 'rss2', 'atom', |
730 |
* or an empty string for the default feed type. |
|
5 | 731 |
*/ |
732 |
return apply_filters( 'feed_link', $output, $feed ); |
|
0 | 733 |
} |
734 |
||
735 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
736 |
* Retrieves the permalink for the post comments feed. |
0 | 737 |
* |
738 |
* @since 2.2.0 |
|
739 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
740 |
* @param int $post_id Optional. Post ID. Default is the ID of the global `$post`. |
16 | 741 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
742 |
* Default is the value of get_default_feed(). |
|
18 | 743 |
* @return string The permalink for the comments feed for the given post on success, empty string on failure. |
0 | 744 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
745 |
function get_post_comments_feed_link( $post_id = 0, $feed = '' ) { |
0 | 746 |
$post_id = absint( $post_id ); |
747 |
||
9 | 748 |
if ( ! $post_id ) { |
0 | 749 |
$post_id = get_the_ID(); |
9 | 750 |
} |
751 |
||
752 |
if ( empty( $feed ) ) { |
|
0 | 753 |
$feed = get_default_feed(); |
9 | 754 |
} |
755 |
||
18 | 756 |
$post = get_post( $post_id ); |
757 |
||
758 |
// Bail out if the post does not exist. |
|
759 |
if ( ! $post instanceof WP_Post ) { |
|
760 |
return ''; |
|
761 |
} |
|
762 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
763 |
$unattached = 'attachment' === $post->post_type && 0 === (int) $post->post_parent; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
764 |
|
16 | 765 |
if ( get_option( 'permalink_structure' ) ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
766 |
if ( 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post_id ) { |
0 | 767 |
$url = _get_page_link( $post_id ); |
9 | 768 |
} else { |
769 |
$url = get_permalink( $post_id ); |
|
770 |
} |
|
0 | 771 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
772 |
if ( $unattached ) { |
9 | 773 |
$url = home_url( '/feed/' ); |
16 | 774 |
if ( get_default_feed() !== $feed ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
775 |
$url .= "$feed/"; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
776 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
777 |
$url = add_query_arg( 'attachment_id', $post_id, $url ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
778 |
} else { |
9 | 779 |
$url = trailingslashit( $url ) . 'feed'; |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
780 |
if ( get_default_feed() !== $feed ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
781 |
$url .= "/$feed"; |
9 | 782 |
} |
783 |
$url = user_trailingslashit( $url, 'single_feed' ); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
784 |
} |
0 | 785 |
} else { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
786 |
if ( $unattached ) { |
9 | 787 |
$url = add_query_arg( |
788 |
array( |
|
789 |
'feed' => $feed, |
|
790 |
'attachment_id' => $post_id, |
|
791 |
), |
|
792 |
home_url( '/' ) |
|
793 |
); |
|
16 | 794 |
} elseif ( 'page' === $post->post_type ) { |
9 | 795 |
$url = add_query_arg( |
796 |
array( |
|
797 |
'feed' => $feed, |
|
798 |
'page_id' => $post_id, |
|
799 |
), |
|
800 |
home_url( '/' ) |
|
801 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
802 |
} else { |
9 | 803 |
$url = add_query_arg( |
804 |
array( |
|
805 |
'feed' => $feed, |
|
806 |
'p' => $post_id, |
|
807 |
), |
|
808 |
home_url( '/' ) |
|
809 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
810 |
} |
0 | 811 |
} |
812 |
||
5 | 813 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
814 |
* Filters the post comments feed permalink. |
5 | 815 |
* |
816 |
* @since 1.5.1 |
|
817 |
* |
|
818 |
* @param string $url Post comments feed permalink. |
|
819 |
*/ |
|
820 |
return apply_filters( 'post_comments_feed_link', $url ); |
|
0 | 821 |
} |
822 |
||
823 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
824 |
* Displays the comment feed link for a post. |
0 | 825 |
* |
826 |
* Prints out the comment feed link for a post. Link text is placed in the |
|
827 |
* anchor. If no link text is specified, default text is used. If no post ID is |
|
828 |
* specified, the current post is used. |
|
829 |
* |
|
830 |
* @since 2.5.0 |
|
831 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
832 |
* @param string $link_text Optional. Descriptive link text. Default 'Comments Feed'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
833 |
* @param int $post_id Optional. Post ID. Default is the ID of the global `$post`. |
16 | 834 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
835 |
* Default is the value of get_default_feed(). |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
836 |
*/ |
0 | 837 |
function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
838 |
$url = get_post_comments_feed_link( $post_id, $feed ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
839 |
if ( empty( $link_text ) ) { |
9 | 840 |
$link_text = __( 'Comments Feed' ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
841 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
842 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
843 |
$link = '<a href="' . esc_url( $url ) . '">' . $link_text . '</a>'; |
5 | 844 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
845 |
* Filters the post comment feed link anchor tag. |
5 | 846 |
* |
847 |
* @since 2.8.0 |
|
848 |
* |
|
849 |
* @param string $link The complete anchor tag for the comment feed link. |
|
850 |
* @param int $post_id Post ID. |
|
16 | 851 |
* @param string $feed The feed type. Possible values include 'rss2', 'atom', |
852 |
* or an empty string for the default feed type. |
|
5 | 853 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
854 |
echo apply_filters( 'post_comments_feed_link_html', $link, $post_id, $feed ); |
0 | 855 |
} |
856 |
||
857 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
858 |
* Retrieves the feed link for a given author. |
0 | 859 |
* |
860 |
* Returns a link to the feed for all posts by a given author. A specific feed |
|
861 |
* can be requested or left blank to get the default feed. |
|
862 |
* |
|
863 |
* @since 2.5.0 |
|
864 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
865 |
* @param int $author_id Author ID. |
16 | 866 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
867 |
* Default is the value of get_default_feed(). |
|
0 | 868 |
* @return string Link to the feed for the author specified by $author_id. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
869 |
*/ |
0 | 870 |
function get_author_feed_link( $author_id, $feed = '' ) { |
9 | 871 |
$author_id = (int) $author_id; |
872 |
$permalink_structure = get_option( 'permalink_structure' ); |
|
873 |
||
874 |
if ( empty( $feed ) ) { |
|
0 | 875 |
$feed = get_default_feed(); |
9 | 876 |
} |
0 | 877 |
|
16 | 878 |
if ( ! $permalink_structure ) { |
9 | 879 |
$link = home_url( "?feed=$feed&author=" . $author_id ); |
0 | 880 |
} else { |
9 | 881 |
$link = get_author_posts_url( $author_id ); |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
882 |
if ( get_default_feed() === $feed ) { |
0 | 883 |
$feed_link = 'feed'; |
9 | 884 |
} else { |
0 | 885 |
$feed_link = "feed/$feed"; |
9 | 886 |
} |
887 |
||
888 |
$link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' ); |
|
0 | 889 |
} |
890 |
||
5 | 891 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
892 |
* Filters the feed link for a given author. |
5 | 893 |
* |
894 |
* @since 1.5.1 |
|
895 |
* |
|
896 |
* @param string $link The author feed link. |
|
16 | 897 |
* @param string $feed Feed type. Possible values include 'rss2', 'atom'. |
5 | 898 |
*/ |
899 |
$link = apply_filters( 'author_feed_link', $link, $feed ); |
|
0 | 900 |
|
901 |
return $link; |
|
902 |
} |
|
903 |
||
904 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
905 |
* Retrieves the feed link for a category. |
0 | 906 |
* |
907 |
* Returns a link to the feed for all posts in a given category. A specific feed |
|
908 |
* can be requested or left blank to get the default feed. |
|
909 |
* |
|
910 |
* @since 2.5.0 |
|
911 |
* |
|
19 | 912 |
* @param int|WP_Term|object $cat The ID or category object whose feed link will be retrieved. |
913 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
|
914 |
* Default is the value of get_default_feed(). |
|
915 |
* @return string Link to the feed for the category specified by `$cat`. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
916 |
*/ |
19 | 917 |
function get_category_feed_link( $cat, $feed = '' ) { |
918 |
return get_term_feed_link( $cat, 'category', $feed ); |
|
0 | 919 |
} |
920 |
||
921 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
922 |
* Retrieves the feed link for a term. |
0 | 923 |
* |
924 |
* Returns a link to the feed for all posts in a given term. A specific feed |
|
925 |
* can be requested or left blank to get the default feed. |
|
926 |
* |
|
5 | 927 |
* @since 3.0.0 |
0 | 928 |
* |
19 | 929 |
* @param int|WP_Term|object $term The ID or term object whose feed link will be retrieved. |
930 |
* @param string $taxonomy Optional. Taxonomy of `$term_id`. |
|
931 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
|
932 |
* Default is the value of get_default_feed(). |
|
933 |
* @return string|false Link to the feed for the term specified by `$term` and `$taxonomy`. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
934 |
*/ |
19 | 935 |
function get_term_feed_link( $term, $taxonomy = '', $feed = '' ) { |
936 |
if ( ! is_object( $term ) ) { |
|
937 |
$term = (int) $term; |
|
938 |
} |
|
939 |
||
940 |
$term = get_term( $term, $taxonomy ); |
|
9 | 941 |
|
942 |
if ( empty( $term ) || is_wp_error( $term ) ) { |
|
0 | 943 |
return false; |
9 | 944 |
} |
945 |
||
19 | 946 |
$taxonomy = $term->taxonomy; |
947 |
||
9 | 948 |
if ( empty( $feed ) ) { |
0 | 949 |
$feed = get_default_feed(); |
9 | 950 |
} |
0 | 951 |
|
952 |
$permalink_structure = get_option( 'permalink_structure' ); |
|
953 |
||
16 | 954 |
if ( ! $permalink_structure ) { |
955 |
if ( 'category' === $taxonomy ) { |
|
19 | 956 |
$link = home_url( "?feed=$feed&cat=$term->term_id" ); |
16 | 957 |
} elseif ( 'post_tag' === $taxonomy ) { |
9 | 958 |
$link = home_url( "?feed=$feed&tag=$term->slug" ); |
0 | 959 |
} else { |
9 | 960 |
$t = get_taxonomy( $taxonomy ); |
961 |
$link = home_url( "?feed=$feed&$t->query_var=$term->slug" ); |
|
0 | 962 |
} |
963 |
} else { |
|
19 | 964 |
$link = get_term_link( $term, $term->taxonomy ); |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
965 |
if ( get_default_feed() === $feed ) { |
0 | 966 |
$feed_link = 'feed'; |
9 | 967 |
} else { |
0 | 968 |
$feed_link = "feed/$feed"; |
9 | 969 |
} |
0 | 970 |
|
971 |
$link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' ); |
|
972 |
} |
|
973 |
||
16 | 974 |
if ( 'category' === $taxonomy ) { |
5 | 975 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
976 |
* Filters the category feed link. |
5 | 977 |
* |
978 |
* @since 1.5.1 |
|
979 |
* |
|
980 |
* @param string $link The category feed link. |
|
16 | 981 |
* @param string $feed Feed type. Possible values include 'rss2', 'atom'. |
5 | 982 |
*/ |
0 | 983 |
$link = apply_filters( 'category_feed_link', $link, $feed ); |
16 | 984 |
} elseif ( 'post_tag' === $taxonomy ) { |
5 | 985 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
986 |
* Filters the post tag feed link. |
5 | 987 |
* |
988 |
* @since 2.3.0 |
|
989 |
* |
|
990 |
* @param string $link The tag feed link. |
|
16 | 991 |
* @param string $feed Feed type. Possible values include 'rss2', 'atom'. |
5 | 992 |
*/ |
0 | 993 |
$link = apply_filters( 'tag_feed_link', $link, $feed ); |
5 | 994 |
} else { |
995 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
996 |
* Filters the feed link for a taxonomy other than 'category' or 'post_tag'. |
5 | 997 |
* |
998 |
* @since 3.0.0 |
|
999 |
* |
|
16 | 1000 |
* @param string $link The taxonomy feed link. |
1001 |
* @param string $feed Feed type. Possible values include 'rss2', 'atom'. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1002 |
* @param string $taxonomy The taxonomy name. |
5 | 1003 |
*/ |
0 | 1004 |
$link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy ); |
5 | 1005 |
} |
0 | 1006 |
|
1007 |
return $link; |
|
1008 |
} |
|
1009 |
||
1010 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1011 |
* Retrieves the permalink for a tag feed. |
0 | 1012 |
* |
1013 |
* @since 2.3.0 |
|
1014 |
* |
|
19 | 1015 |
* @param int|WP_Term|object $tag The ID or term object whose feed link will be retrieved. |
1016 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
|
1017 |
* Default is the value of get_default_feed(). |
|
1018 |
* @return string The feed permalink for the given tag. |
|
0 | 1019 |
*/ |
19 | 1020 |
function get_tag_feed_link( $tag, $feed = '' ) { |
1021 |
return get_term_feed_link( $tag, 'post_tag', $feed ); |
|
0 | 1022 |
} |
1023 |
||
1024 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1025 |
* Retrieves the edit link for a tag. |
0 | 1026 |
* |
1027 |
* @since 2.7.0 |
|
1028 |
* |
|
19 | 1029 |
* @param int|WP_Term|object $tag The ID or term object whose edit link will be retrieved. |
1030 |
* @param string $taxonomy Optional. Taxonomy slug. Default 'post_tag'. |
|
5 | 1031 |
* @return string The edit tag link URL for the given tag. |
0 | 1032 |
*/ |
19 | 1033 |
function get_edit_tag_link( $tag, $taxonomy = 'post_tag' ) { |
5 | 1034 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1035 |
* Filters the edit link for a tag (or term in another taxonomy). |
5 | 1036 |
* |
1037 |
* @since 2.7.0 |
|
1038 |
* |
|
1039 |
* @param string $link The term edit link. |
|
1040 |
*/ |
|
19 | 1041 |
return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag, $taxonomy ) ); |
0 | 1042 |
} |
1043 |
||
1044 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1045 |
* Displays or retrieves the edit link for a tag with formatting. |
0 | 1046 |
* |
1047 |
* @since 2.7.0 |
|
1048 |
* |
|
16 | 1049 |
* @param string $link Optional. Anchor text. If empty, default is 'Edit This'. Default empty. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1050 |
* @param string $before Optional. Display before edit link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1051 |
* @param string $after Optional. Display after edit link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1052 |
* @param WP_Term $tag Optional. Term object. If null, the queried object will be inspected. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1053 |
* Default null. |
0 | 1054 |
*/ |
1055 |
function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) { |
|
1056 |
$link = edit_term_link( $link, '', '', $tag, false ); |
|
5 | 1057 |
|
1058 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1059 |
* Filters the anchor tag for the edit link for a tag (or term in another taxonomy). |
5 | 1060 |
* |
1061 |
* @since 2.7.0 |
|
1062 |
* |
|
1063 |
* @param string $link The anchor tag for the edit link. |
|
1064 |
*/ |
|
0 | 1065 |
echo $before . apply_filters( 'edit_tag_link', $link ) . $after; |
1066 |
} |
|
1067 |
||
1068 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1069 |
* Retrieves the URL for editing a given term. |
0 | 1070 |
* |
1071 |
* @since 3.1.0 |
|
16 | 1072 |
* @since 4.5.0 The `$taxonomy` parameter was made optional. |
0 | 1073 |
* |
19 | 1074 |
* @param int|WP_Term|object $term The ID or term object whose edit link will be retrieved. |
1075 |
* @param string $taxonomy Optional. Taxonomy. Defaults to the taxonomy of the term identified |
|
1076 |
* by `$term`. |
|
1077 |
* @param string $object_type Optional. The object type. Used to highlight the proper post type |
|
1078 |
* menu on the linked page. Defaults to the first object_type associated |
|
1079 |
* with the taxonomy. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1080 |
* @return string|null The edit term link URL for the given term, or null on failure. |
0 | 1081 |
*/ |
19 | 1082 |
function get_edit_term_link( $term, $taxonomy = '', $object_type = '' ) { |
1083 |
$term = get_term( $term, $taxonomy ); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1084 |
if ( ! $term || is_wp_error( $term ) ) { |
0 | 1085 |
return; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1086 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1087 |
|
19 | 1088 |
$tax = get_taxonomy( $term->taxonomy ); |
1089 |
$term_id = $term->term_id; |
|
1090 |
if ( ! $tax || ! current_user_can( 'edit_term', $term_id ) ) { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1091 |
return; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1092 |
} |
0 | 1093 |
|
1094 |
$args = array( |
|
1095 |
'taxonomy' => $taxonomy, |
|
19 | 1096 |
'tag_ID' => $term_id, |
0 | 1097 |
); |
1098 |
||
5 | 1099 |
if ( $object_type ) { |
0 | 1100 |
$args['post_type'] = $object_type; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1101 |
} elseif ( ! empty( $tax->object_type ) ) { |
5 | 1102 |
$args['post_type'] = reset( $tax->object_type ); |
1103 |
} |
|
0 | 1104 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1105 |
if ( $tax->show_ui ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1106 |
$location = add_query_arg( $args, admin_url( 'term.php' ) ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1107 |
} else { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1108 |
$location = ''; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1109 |
} |
0 | 1110 |
|
5 | 1111 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1112 |
* Filters the edit link for a term. |
5 | 1113 |
* |
1114 |
* @since 3.1.0 |
|
1115 |
* |
|
1116 |
* @param string $location The edit link. |
|
1117 |
* @param int $term_id Term ID. |
|
1118 |
* @param string $taxonomy Taxonomy name. |
|
19 | 1119 |
* @param string $object_type The object type. |
5 | 1120 |
*/ |
0 | 1121 |
return apply_filters( 'get_edit_term_link', $location, $term_id, $taxonomy, $object_type ); |
1122 |
} |
|
1123 |
||
1124 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1125 |
* Displays or retrieves the edit term link with formatting. |
0 | 1126 |
* |
1127 |
* @since 3.1.0 |
|
1128 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1129 |
* @param string $link Optional. Anchor text. If empty, default is 'Edit This'. Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1130 |
* @param string $before Optional. Display before edit link. Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1131 |
* @param string $after Optional. Display after edit link. Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1132 |
* @param int|WP_Term|null $term Optional. Term ID or object. If null, the queried object will be inspected. Default null. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1133 |
* @param bool $display Optional. Whether or not to echo the return. Default true. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1134 |
* @return string|void HTML content. |
0 | 1135 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1136 |
function edit_term_link( $link = '', $before = '', $after = '', $term = null, $display = true ) { |
9 | 1137 |
if ( is_null( $term ) ) { |
0 | 1138 |
$term = get_queried_object(); |
19 | 1139 |
} else { |
1140 |
$term = get_term( $term ); |
|
9 | 1141 |
} |
1142 |
||
1143 |
if ( ! $term ) { |
|
0 | 1144 |
return; |
9 | 1145 |
} |
0 | 1146 |
|
1147 |
$tax = get_taxonomy( $term->taxonomy ); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1148 |
if ( ! current_user_can( 'edit_term', $term->term_id ) ) { |
0 | 1149 |
return; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1150 |
} |
0 | 1151 |
|
9 | 1152 |
if ( empty( $link ) ) { |
1153 |
$link = __( 'Edit This' ); |
|
1154 |
} |
|
0 | 1155 |
|
1156 |
$link = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '">' . $link . '</a>'; |
|
5 | 1157 |
|
1158 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1159 |
* Filters the anchor tag for the edit link of a term. |
5 | 1160 |
* |
1161 |
* @since 3.1.0 |
|
1162 |
* |
|
1163 |
* @param string $link The anchor tag for the edit link. |
|
1164 |
* @param int $term_id Term ID. |
|
1165 |
*/ |
|
0 | 1166 |
$link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after; |
1167 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1168 |
if ( $display ) { |
0 | 1169 |
echo $link; |
9 | 1170 |
} else { |
0 | 1171 |
return $link; |
9 | 1172 |
} |
0 | 1173 |
} |
1174 |
||
1175 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1176 |
* Retrieves the permalink for a search. |
5 | 1177 |
* |
16 | 1178 |
* @since 3.0.0 |
1179 |
* |
|
1180 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1181 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1182 |
* @param string $query Optional. The query string to use. If empty the current query is used. Default empty. |
5 | 1183 |
* @return string The search permalink. |
1184 |
*/ |
|
0 | 1185 |
function get_search_link( $query = '' ) { |
1186 |
global $wp_rewrite; |
|
1187 |
||
9 | 1188 |
if ( empty( $query ) ) { |
0 | 1189 |
$search = get_search_query( false ); |
9 | 1190 |
} else { |
1191 |
$search = stripslashes( $query ); |
|
1192 |
} |
|
0 | 1193 |
|
1194 |
$permastruct = $wp_rewrite->get_search_permastruct(); |
|
1195 |
||
1196 |
if ( empty( $permastruct ) ) { |
|
9 | 1197 |
$link = home_url( '?s=' . urlencode( $search ) ); |
0 | 1198 |
} else { |
9 | 1199 |
$search = urlencode( $search ); |
1200 |
$search = str_replace( '%2F', '/', $search ); // %2F(/) is not valid within a URL, send it un-encoded. |
|
1201 |
$link = str_replace( '%search%', $search, $permastruct ); |
|
1202 |
$link = home_url( user_trailingslashit( $link, 'search' ) ); |
|
0 | 1203 |
} |
1204 |
||
5 | 1205 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1206 |
* Filters the search permalink. |
5 | 1207 |
* |
1208 |
* @since 3.0.0 |
|
1209 |
* |
|
1210 |
* @param string $link Search permalink. |
|
1211 |
* @param string $search The URL-encoded search term. |
|
1212 |
*/ |
|
0 | 1213 |
return apply_filters( 'search_link', $link, $search ); |
1214 |
} |
|
1215 |
||
1216 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1217 |
* Retrieves the permalink for the search results feed. |
0 | 1218 |
* |
1219 |
* @since 2.5.0 |
|
1220 |
* |
|
16 | 1221 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1222 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1223 |
* @param string $search_query Optional. Search query. Default empty. |
16 | 1224 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
1225 |
* Default is the value of get_default_feed(). |
|
5 | 1226 |
* @return string The search results feed permalink. |
0 | 1227 |
*/ |
9 | 1228 |
function get_search_feed_link( $search_query = '', $feed = '' ) { |
0 | 1229 |
global $wp_rewrite; |
9 | 1230 |
$link = get_search_link( $search_query ); |
1231 |
||
1232 |
if ( empty( $feed ) ) { |
|
0 | 1233 |
$feed = get_default_feed(); |
9 | 1234 |
} |
0 | 1235 |
|
1236 |
$permastruct = $wp_rewrite->get_search_permastruct(); |
|
1237 |
||
9 | 1238 |
if ( empty( $permastruct ) ) { |
1239 |
$link = add_query_arg( 'feed', $feed, $link ); |
|
0 | 1240 |
} else { |
9 | 1241 |
$link = trailingslashit( $link ); |
0 | 1242 |
$link .= "feed/$feed/"; |
1243 |
} |
|
1244 |
||
5 | 1245 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1246 |
* Filters the search feed link. |
5 | 1247 |
* |
1248 |
* @since 2.5.0 |
|
1249 |
* |
|
1250 |
* @param string $link Search feed link. |
|
16 | 1251 |
* @param string $feed Feed type. Possible values include 'rss2', 'atom'. |
5 | 1252 |
* @param string $type The search type. One of 'posts' or 'comments'. |
1253 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1254 |
return apply_filters( 'search_feed_link', $link, $feed, 'posts' ); |
0 | 1255 |
} |
1256 |
||
1257 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1258 |
* Retrieves the permalink for the search results comments feed. |
0 | 1259 |
* |
1260 |
* @since 2.5.0 |
|
1261 |
* |
|
16 | 1262 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1263 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1264 |
* @param string $search_query Optional. Search query. Default empty. |
16 | 1265 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
1266 |
* Default is the value of get_default_feed(). |
|
5 | 1267 |
* @return string The comments feed search results permalink. |
0 | 1268 |
*/ |
9 | 1269 |
function get_search_comments_feed_link( $search_query = '', $feed = '' ) { |
0 | 1270 |
global $wp_rewrite; |
1271 |
||
9 | 1272 |
if ( empty( $feed ) ) { |
0 | 1273 |
$feed = get_default_feed(); |
9 | 1274 |
} |
1275 |
||
1276 |
$link = get_search_feed_link( $search_query, $feed ); |
|
0 | 1277 |
|
1278 |
$permastruct = $wp_rewrite->get_search_permastruct(); |
|
1279 |
||
9 | 1280 |
if ( empty( $permastruct ) ) { |
1281 |
$link = add_query_arg( 'feed', 'comments-' . $feed, $link ); |
|
1282 |
} else { |
|
1283 |
$link = add_query_arg( 'withcomments', 1, $link ); |
|
1284 |
} |
|
0 | 1285 |
|
5 | 1286 |
/** This filter is documented in wp-includes/link-template.php */ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1287 |
return apply_filters( 'search_feed_link', $link, $feed, 'comments' ); |
0 | 1288 |
} |
1289 |
||
1290 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1291 |
* Retrieves the permalink for a post type archive. |
0 | 1292 |
* |
1293 |
* @since 3.1.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1294 |
* @since 4.5.0 Support for posts was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1295 |
* |
16 | 1296 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1297 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1298 |
* @param string $post_type Post type. |
18 | 1299 |
* @return string|false The post type archive permalink. False if the post type |
1300 |
* does not exist or does not have an archive. |
|
0 | 1301 |
*/ |
1302 |
function get_post_type_archive_link( $post_type ) { |
|
1303 |
global $wp_rewrite; |
|
16 | 1304 |
|
1305 |
$post_type_obj = get_post_type_object( $post_type ); |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1306 |
|
16 | 1307 |
if ( ! $post_type_obj ) { |
0 | 1308 |
return false; |
9 | 1309 |
} |
0 | 1310 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1311 |
if ( 'post' === $post_type ) { |
9 | 1312 |
$show_on_front = get_option( 'show_on_front' ); |
1313 |
$page_for_posts = get_option( 'page_for_posts' ); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1314 |
|
16 | 1315 |
if ( 'page' === $show_on_front && $page_for_posts ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1316 |
$link = get_permalink( $page_for_posts ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1317 |
} else { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1318 |
$link = get_home_url(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1319 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1320 |
/** This filter is documented in wp-includes/link-template.php */ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1321 |
return apply_filters( 'post_type_archive_link', $link, $post_type ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1322 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1323 |
|
9 | 1324 |
if ( ! $post_type_obj->has_archive ) { |
0 | 1325 |
return false; |
9 | 1326 |
} |
0 | 1327 |
|
1328 |
if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) ) { |
|
1329 |
$struct = ( true === $post_type_obj->has_archive ) ? $post_type_obj->rewrite['slug'] : $post_type_obj->has_archive; |
|
9 | 1330 |
if ( $post_type_obj->rewrite['with_front'] ) { |
0 | 1331 |
$struct = $wp_rewrite->front . $struct; |
9 | 1332 |
} else { |
0 | 1333 |
$struct = $wp_rewrite->root . $struct; |
9 | 1334 |
} |
0 | 1335 |
$link = home_url( user_trailingslashit( $struct, 'post_type_archive' ) ); |
1336 |
} else { |
|
1337 |
$link = home_url( '?post_type=' . $post_type ); |
|
1338 |
} |
|
1339 |
||
5 | 1340 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1341 |
* Filters the post type archive permalink. |
5 | 1342 |
* |
1343 |
* @since 3.1.0 |
|
1344 |
* |
|
1345 |
* @param string $link The post type archive permalink. |
|
1346 |
* @param string $post_type Post type name. |
|
1347 |
*/ |
|
0 | 1348 |
return apply_filters( 'post_type_archive_link', $link, $post_type ); |
1349 |
} |
|
1350 |
||
1351 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1352 |
* Retrieves the permalink for a post type archive feed. |
0 | 1353 |
* |
1354 |
* @since 3.1.0 |
|
1355 |
* |
|
18 | 1356 |
* @param string $post_type Post type. |
16 | 1357 |
* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. |
1358 |
* Default is the value of get_default_feed(). |
|
18 | 1359 |
* @return string|false The post type feed permalink. False if the post type |
1360 |
* does not exist or does not have an archive. |
|
0 | 1361 |
*/ |
1362 |
function get_post_type_archive_feed_link( $post_type, $feed = '' ) { |
|
1363 |
$default_feed = get_default_feed(); |
|
9 | 1364 |
if ( empty( $feed ) ) { |
0 | 1365 |
$feed = $default_feed; |
9 | 1366 |
} |
1367 |
||
16 | 1368 |
$link = get_post_type_archive_link( $post_type ); |
1369 |
if ( ! $link ) { |
|
0 | 1370 |
return false; |
9 | 1371 |
} |
0 | 1372 |
|
1373 |
$post_type_obj = get_post_type_object( $post_type ); |
|
1374 |
if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) && $post_type_obj->rewrite['feeds'] ) { |
|
9 | 1375 |
$link = trailingslashit( $link ); |
0 | 1376 |
$link .= 'feed/'; |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1377 |
if ( $feed !== $default_feed ) { |
0 | 1378 |
$link .= "$feed/"; |
9 | 1379 |
} |
0 | 1380 |
} else { |
1381 |
$link = add_query_arg( 'feed', $feed, $link ); |
|
1382 |
} |
|
1383 |
||
5 | 1384 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1385 |
* Filters the post type archive feed link. |
5 | 1386 |
* |
1387 |
* @since 3.1.0 |
|
1388 |
* |
|
1389 |
* @param string $link The post type archive feed link. |
|
16 | 1390 |
* @param string $feed Feed type. Possible values include 'rss2', 'atom'. |
5 | 1391 |
*/ |
0 | 1392 |
return apply_filters( 'post_type_archive_feed_link', $link, $feed ); |
1393 |
} |
|
1394 |
||
1395 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1396 |
* Retrieves the URL used for the post preview. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1397 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1398 |
* Allows additional query args to be appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1399 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1400 |
* @since 4.4.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1401 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1402 |
* @param int|WP_Post $post Optional. Post ID or `WP_Post` object. Defaults to global `$post`. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1403 |
* @param array $query_args Optional. Array of additional query args to be appended to the link. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1404 |
* Default empty array. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1405 |
* @param string $preview_link Optional. Base preview link to be used if it should differ from the |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1406 |
* post permalink. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1407 |
* @return string|null URL used for the post preview, or null if the post does not exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1408 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1409 |
function get_preview_post_link( $post = null, $query_args = array(), $preview_link = '' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1410 |
$post = get_post( $post ); |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1411 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1412 |
if ( ! $post ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1413 |
return; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1414 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1415 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1416 |
$post_type_object = get_post_type_object( $post->post_type ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1417 |
if ( is_post_type_viewable( $post_type_object ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1418 |
if ( ! $preview_link ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1419 |
$preview_link = set_url_scheme( get_permalink( $post ) ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1420 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1421 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1422 |
$query_args['preview'] = 'true'; |
9 | 1423 |
$preview_link = add_query_arg( $query_args, $preview_link ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1424 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1425 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1426 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1427 |
* Filters the URL used for a post preview. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1428 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1429 |
* @since 2.0.5 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1430 |
* @since 4.0.0 Added the `$post` parameter. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1431 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1432 |
* @param string $preview_link URL used for the post preview. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1433 |
* @param WP_Post $post Post object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1434 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1435 |
return apply_filters( 'preview_post_link', $preview_link, $post ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1436 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1437 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1438 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1439 |
* Retrieves the edit post link for post. |
0 | 1440 |
* |
1441 |
* Can be used within the WordPress loop or outside of it. Can be used with |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1442 |
* pages, posts, attachments, revisions, global styles, templates, and template parts. |
0 | 1443 |
* |
1444 |
* @since 2.3.0 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1445 |
* @since 6.3.0 Adds custom link for wp_navigation post types. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1446 |
* Adds custom links for wp_template_part and wp_template post types. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1447 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1448 |
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1449 |
* @param string $context Optional. How to output the '&' character. Default '&'. |
18 | 1450 |
* @return string|null The edit post link for the given post. Null if the post type does not exist |
1451 |
* or does not allow an editing UI. |
|
0 | 1452 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1453 |
function get_edit_post_link( $post = 0, $context = 'display' ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1454 |
$post = get_post( $post ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1455 |
|
16 | 1456 |
if ( ! $post ) { |
0 | 1457 |
return; |
9 | 1458 |
} |
1459 |
||
1460 |
if ( 'revision' === $post->post_type ) { |
|
0 | 1461 |
$action = ''; |
16 | 1462 |
} elseif ( 'display' === $context ) { |
0 | 1463 |
$action = '&action=edit'; |
9 | 1464 |
} else { |
0 | 1465 |
$action = '&action=edit'; |
9 | 1466 |
} |
0 | 1467 |
|
1468 |
$post_type_object = get_post_type_object( $post->post_type ); |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1469 |
|
9 | 1470 |
if ( ! $post_type_object ) { |
0 | 1471 |
return; |
9 | 1472 |
} |
1473 |
||
1474 |
if ( ! current_user_can( 'edit_post', $post->ID ) ) { |
|
0 | 1475 |
return; |
9 | 1476 |
} |
0 | 1477 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1478 |
$link = ''; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1479 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1480 |
if ( 'wp_template' === $post->post_type || 'wp_template_part' === $post->post_type ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1481 |
$slug = urlencode( get_stylesheet() . '//' . $post->post_name ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1482 |
$link = admin_url( sprintf( $post_type_object->_edit_link, $post->post_type, $slug ) ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1483 |
} elseif ( 'wp_navigation' === $post->post_type ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1484 |
$link = admin_url( sprintf( $post_type_object->_edit_link, (string) $post->ID ) ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1485 |
} elseif ( $post_type_object->_edit_link ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1486 |
$link = admin_url( sprintf( $post_type_object->_edit_link . $action, $post->ID ) ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1487 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1488 |
|
5 | 1489 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1490 |
* Filters the post edit link. |
5 | 1491 |
* |
1492 |
* @since 2.3.0 |
|
1493 |
* |
|
1494 |
* @param string $link The edit link. |
|
1495 |
* @param int $post_id Post ID. |
|
1496 |
* @param string $context The link context. If set to 'display' then ampersands |
|
1497 |
* are encoded. |
|
1498 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1499 |
return apply_filters( 'get_edit_post_link', $link, $post->ID, $context ); |
0 | 1500 |
} |
1501 |
||
1502 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1503 |
* Displays the edit post link for post. |
0 | 1504 |
* |
1505 |
* @since 1.0.0 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1506 |
* @since 4.4.0 The `$css_class` argument was added. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1507 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1508 |
* @param string $text Optional. Anchor text. If null, default is 'Edit This'. Default null. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1509 |
* @param string $before Optional. Display before edit link. Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1510 |
* @param string $after Optional. Display after edit link. Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1511 |
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1512 |
* @param string $css_class Optional. Add custom class to link. Default 'post-edit-link'. |
0 | 1513 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1514 |
function edit_post_link( $text = null, $before = '', $after = '', $post = 0, $css_class = 'post-edit-link' ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1515 |
$post = get_post( $post ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1516 |
|
16 | 1517 |
if ( ! $post ) { |
0 | 1518 |
return; |
5 | 1519 |
} |
1520 |
||
16 | 1521 |
$url = get_edit_post_link( $post->ID ); |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1522 |
|
16 | 1523 |
if ( ! $url ) { |
0 | 1524 |
return; |
5 | 1525 |
} |
1526 |
||
1527 |
if ( null === $text ) { |
|
1528 |
$text = __( 'Edit This' ); |
|
1529 |
} |
|
1530 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1531 |
$link = '<a class="' . esc_attr( $css_class ) . '" href="' . esc_url( $url ) . '">' . $text . '</a>'; |
5 | 1532 |
|
1533 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1534 |
* Filters the post edit link anchor tag. |
5 | 1535 |
* |
1536 |
* @since 2.3.0 |
|
1537 |
* |
|
1538 |
* @param string $link Anchor tag for the edit link. |
|
1539 |
* @param int $post_id Post ID. |
|
1540 |
* @param string $text Anchor text. |
|
1541 |
*/ |
|
1542 |
echo $before . apply_filters( 'edit_post_link', $link, $post->ID, $text ) . $after; |
|
0 | 1543 |
} |
1544 |
||
1545 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1546 |
* Retrieves the delete posts link for post. |
0 | 1547 |
* |
1548 |
* Can be used within the WordPress loop or outside of it, with any post type. |
|
1549 |
* |
|
1550 |
* @since 2.9.0 |
|
1551 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1552 |
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1553 |
* @param string $deprecated Not used. |
16 | 1554 |
* @param bool $force_delete Optional. Whether to bypass Trash and force deletion. Default false. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1555 |
* @return string|void The delete post link URL for the given post. |
0 | 1556 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1557 |
function get_delete_post_link( $post = 0, $deprecated = '', $force_delete = false ) { |
9 | 1558 |
if ( ! empty( $deprecated ) ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1559 |
_deprecated_argument( __FUNCTION__, '3.0.0' ); |
9 | 1560 |
} |
1561 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1562 |
$post = get_post( $post ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1563 |
|
16 | 1564 |
if ( ! $post ) { |
0 | 1565 |
return; |
9 | 1566 |
} |
0 | 1567 |
|
1568 |
$post_type_object = get_post_type_object( $post->post_type ); |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1569 |
|
9 | 1570 |
if ( ! $post_type_object ) { |
0 | 1571 |
return; |
9 | 1572 |
} |
1573 |
||
1574 |
if ( ! current_user_can( 'delete_post', $post->ID ) ) { |
|
0 | 1575 |
return; |
9 | 1576 |
} |
1577 |
||
1578 |
$action = ( $force_delete || ! EMPTY_TRASH_DAYS ) ? 'delete' : 'trash'; |
|
0 | 1579 |
|
1580 |
$delete_link = add_query_arg( 'action', $action, admin_url( sprintf( $post_type_object->_edit_link, $post->ID ) ) ); |
|
1581 |
||
5 | 1582 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1583 |
* Filters the post delete link. |
5 | 1584 |
* |
1585 |
* @since 2.9.0 |
|
1586 |
* |
|
1587 |
* @param string $link The delete link. |
|
1588 |
* @param int $post_id Post ID. |
|
16 | 1589 |
* @param bool $force_delete Whether to bypass the Trash and force deletion. Default false. |
5 | 1590 |
*/ |
0 | 1591 |
return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-post_{$post->ID}" ), $post->ID, $force_delete ); |
1592 |
} |
|
1593 |
||
1594 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1595 |
* Retrieves the edit comment link. |
0 | 1596 |
* |
1597 |
* @since 2.3.0 |
|
1598 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1599 |
* @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1600 |
* @return string|void The edit comment link URL for the given comment. |
0 | 1601 |
*/ |
1602 |
function get_edit_comment_link( $comment_id = 0 ) { |
|
1603 |
$comment = get_comment( $comment_id ); |
|
1604 |
||
9 | 1605 |
if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) { |
0 | 1606 |
return; |
9 | 1607 |
} |
1608 |
||
1609 |
$location = admin_url( 'comment.php?action=editcomment&c=' ) . $comment->comment_ID; |
|
5 | 1610 |
|
1611 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1612 |
* Filters the comment edit link. |
5 | 1613 |
* |
1614 |
* @since 2.3.0 |
|
1615 |
* |
|
1616 |
* @param string $location The edit link. |
|
1617 |
*/ |
|
0 | 1618 |
return apply_filters( 'get_edit_comment_link', $location ); |
1619 |
} |
|
1620 |
||
1621 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1622 |
* Displays the edit comment link with formatting. |
0 | 1623 |
* |
1624 |
* @since 1.0.0 |
|
1625 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1626 |
* @param string $text Optional. Anchor text. If null, default is 'Edit This'. Default null. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1627 |
* @param string $before Optional. Display before edit link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1628 |
* @param string $after Optional. Display after edit link. Default empty. |
0 | 1629 |
*/ |
5 | 1630 |
function edit_comment_link( $text = null, $before = '', $after = '' ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1631 |
$comment = get_comment(); |
0 | 1632 |
|
5 | 1633 |
if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) { |
0 | 1634 |
return; |
5 | 1635 |
} |
1636 |
||
1637 |
if ( null === $text ) { |
|
1638 |
$text = __( 'Edit This' ); |
|
1639 |
} |
|
1640 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1641 |
$link = '<a class="comment-edit-link" href="' . esc_url( get_edit_comment_link( $comment ) ) . '">' . $text . '</a>'; |
5 | 1642 |
|
1643 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1644 |
* Filters the comment edit link anchor tag. |
5 | 1645 |
* |
1646 |
* @since 2.3.0 |
|
1647 |
* |
|
1648 |
* @param string $link Anchor tag for the edit link. |
|
19 | 1649 |
* @param string $comment_id Comment ID as a numeric string. |
5 | 1650 |
* @param string $text Anchor text. |
1651 |
*/ |
|
1652 |
echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID, $text ) . $after; |
|
0 | 1653 |
} |
1654 |
||
1655 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1656 |
* Displays the edit bookmark link. |
0 | 1657 |
* |
1658 |
* @since 2.7.0 |
|
1659 |
* |
|
16 | 1660 |
* @param int|stdClass $link Optional. Bookmark ID. Default is the ID of the current bookmark. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1661 |
* @return string|void The edit bookmark link URL. |
0 | 1662 |
*/ |
1663 |
function get_edit_bookmark_link( $link = 0 ) { |
|
1664 |
$link = get_bookmark( $link ); |
|
1665 |
||
9 | 1666 |
if ( ! current_user_can( 'manage_links' ) ) { |
0 | 1667 |
return; |
9 | 1668 |
} |
1669 |
||
1670 |
$location = admin_url( 'link.php?action=edit&link_id=' ) . $link->link_id; |
|
5 | 1671 |
|
1672 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1673 |
* Filters the bookmark edit link. |
5 | 1674 |
* |
1675 |
* @since 2.7.0 |
|
1676 |
* |
|
1677 |
* @param string $location The edit link. |
|
1678 |
* @param int $link_id Bookmark ID. |
|
1679 |
*/ |
|
0 | 1680 |
return apply_filters( 'get_edit_bookmark_link', $location, $link->link_id ); |
1681 |
} |
|
1682 |
||
1683 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1684 |
* Displays the edit bookmark link anchor content. |
0 | 1685 |
* |
1686 |
* @since 2.7.0 |
|
1687 |
* |
|
16 | 1688 |
* @param string $link Optional. Anchor text. If empty, default is 'Edit This'. Default empty. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1689 |
* @param string $before Optional. Display before edit link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1690 |
* @param string $after Optional. Display after edit link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1691 |
* @param int $bookmark Optional. Bookmark ID. Default is the current bookmark. |
0 | 1692 |
*/ |
1693 |
function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) { |
|
9 | 1694 |
$bookmark = get_bookmark( $bookmark ); |
1695 |
||
1696 |
if ( ! current_user_can( 'manage_links' ) ) { |
|
0 | 1697 |
return; |
9 | 1698 |
} |
1699 |
||
1700 |
if ( empty( $link ) ) { |
|
1701 |
$link = __( 'Edit This' ); |
|
1702 |
} |
|
0 | 1703 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1704 |
$link = '<a href="' . esc_url( get_edit_bookmark_link( $bookmark ) ) . '">' . $link . '</a>'; |
5 | 1705 |
|
1706 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1707 |
* Filters the bookmark edit link anchor tag. |
5 | 1708 |
* |
1709 |
* @since 2.7.0 |
|
1710 |
* |
|
1711 |
* @param string $link Anchor tag for the edit link. |
|
1712 |
* @param int $link_id Bookmark ID. |
|
1713 |
*/ |
|
0 | 1714 |
echo $before . apply_filters( 'edit_bookmark_link', $link, $bookmark->link_id ) . $after; |
1715 |
} |
|
1716 |
||
1717 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1718 |
* Retrieves the edit user link. |
0 | 1719 |
* |
1720 |
* @since 3.5.0 |
|
1721 |
* |
|
1722 |
* @param int $user_id Optional. User ID. Defaults to the current user. |
|
1723 |
* @return string URL to edit user page or empty string. |
|
1724 |
*/ |
|
1725 |
function get_edit_user_link( $user_id = null ) { |
|
9 | 1726 |
if ( ! $user_id ) { |
0 | 1727 |
$user_id = get_current_user_id(); |
9 | 1728 |
} |
1729 |
||
1730 |
if ( empty( $user_id ) || ! current_user_can( 'edit_user', $user_id ) ) { |
|
0 | 1731 |
return ''; |
9 | 1732 |
} |
0 | 1733 |
|
1734 |
$user = get_userdata( $user_id ); |
|
1735 |
||
9 | 1736 |
if ( ! $user ) { |
0 | 1737 |
return ''; |
9 | 1738 |
} |
1739 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1740 |
if ( get_current_user_id() === $user->ID ) { |
0 | 1741 |
$link = get_edit_profile_url( $user->ID ); |
9 | 1742 |
} else { |
0 | 1743 |
$link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) ); |
9 | 1744 |
} |
0 | 1745 |
|
5 | 1746 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1747 |
* Filters the user edit link. |
5 | 1748 |
* |
1749 |
* @since 3.5.0 |
|
1750 |
* |
|
1751 |
* @param string $link The edit link. |
|
1752 |
* @param int $user_id User ID. |
|
1753 |
*/ |
|
0 | 1754 |
return apply_filters( 'get_edit_user_link', $link, $user->ID ); |
1755 |
} |
|
1756 |
||
16 | 1757 |
// |
1758 |
// Navigation links. |
|
1759 |
// |
|
0 | 1760 |
|
1761 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1762 |
* Retrieves the previous post that is adjacent to the current post. |
0 | 1763 |
* |
1764 |
* @since 1.5.0 |
|
1765 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1766 |
* @param bool $in_same_term Optional. Whether post should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1767 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1768 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1769 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1770 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1771 |
* @return WP_Post|null|string Post object if successful. Null if global `$post` is not set. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1772 |
* Empty string if no corresponding post exists. |
0 | 1773 |
*/ |
5 | 1774 |
function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
1775 |
return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy ); |
|
0 | 1776 |
} |
1777 |
||
1778 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1779 |
* Retrieves the next post that is adjacent to the current post. |
0 | 1780 |
* |
1781 |
* @since 1.5.0 |
|
1782 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1783 |
* @param bool $in_same_term Optional. Whether post should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1784 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1785 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1786 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1787 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1788 |
* @return WP_Post|null|string Post object if successful. Null if global `$post` is not set. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1789 |
* Empty string if no corresponding post exists. |
0 | 1790 |
*/ |
5 | 1791 |
function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
1792 |
return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy ); |
|
0 | 1793 |
} |
1794 |
||
1795 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1796 |
* Retrieves the adjacent post. |
0 | 1797 |
* |
1798 |
* Can either be next or previous post. |
|
1799 |
* |
|
1800 |
* @since 2.5.0 |
|
1801 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1802 |
* @global wpdb $wpdb WordPress database abstraction object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1803 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1804 |
* @param bool $in_same_term Optional. Whether post should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1805 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1806 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1807 |
* Default empty string. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1808 |
* @param bool $previous Optional. Whether to retrieve previous post. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1809 |
* Default true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1810 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1811 |
* @return WP_Post|null|string Post object if successful. Null if global `$post` is not set. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1812 |
* Empty string if no corresponding post exists. |
0 | 1813 |
*/ |
5 | 1814 |
function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { |
0 | 1815 |
global $wpdb; |
1816 |
||
16 | 1817 |
$post = get_post(); |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1818 |
|
16 | 1819 |
if ( ! $post || ! taxonomy_exists( $taxonomy ) ) { |
0 | 1820 |
return null; |
9 | 1821 |
} |
0 | 1822 |
|
1823 |
$current_post_date = $post->post_date; |
|
1824 |
||
9 | 1825 |
$join = ''; |
1826 |
$where = ''; |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1827 |
$adjacent = $previous ? 'previous' : 'next'; |
5 | 1828 |
|
9 | 1829 |
if ( ! empty( $excluded_terms ) && ! is_array( $excluded_terms ) ) { |
1830 |
// Back-compat, $excluded_terms used to be $excluded_categories with IDs separated by " and ". |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1831 |
if ( str_contains( $excluded_terms, ' and ' ) ) { |
16 | 1832 |
_deprecated_argument( |
1833 |
__FUNCTION__, |
|
1834 |
'3.3.0', |
|
1835 |
sprintf( |
|
1836 |
/* translators: %s: The word 'and'. */ |
|
1837 |
__( 'Use commas instead of %s to separate excluded terms.' ), |
|
1838 |
"'and'" |
|
1839 |
) |
|
1840 |
); |
|
9 | 1841 |
$excluded_terms = explode( ' and ', $excluded_terms ); |
1842 |
} else { |
|
1843 |
$excluded_terms = explode( ',', $excluded_terms ); |
|
1844 |
} |
|
1845 |
||
1846 |
$excluded_terms = array_map( 'intval', $excluded_terms ); |
|
1847 |
} |
|
1848 |
||
1849 |
/** |
|
1850 |
* Filters the IDs of terms excluded from adjacent post queries. |
|
1851 |
* |
|
1852 |
* The dynamic portion of the hook name, `$adjacent`, refers to the type |
|
1853 |
* of adjacency, 'next' or 'previous'. |
|
1854 |
* |
|
18 | 1855 |
* Possible hook names include: |
1856 |
* |
|
1857 |
* - `get_next_post_excluded_terms` |
|
1858 |
* - `get_previous_post_excluded_terms` |
|
1859 |
* |
|
9 | 1860 |
* @since 4.4.0 |
1861 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1862 |
* @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided. |
9 | 1863 |
*/ |
1864 |
$excluded_terms = apply_filters( "get_{$adjacent}_post_excluded_terms", $excluded_terms ); |
|
1865 |
||
5 | 1866 |
if ( $in_same_term || ! empty( $excluded_terms ) ) { |
9 | 1867 |
if ( $in_same_term ) { |
19 | 1868 |
$join .= " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id"; |
9 | 1869 |
$where .= $wpdb->prepare( 'AND tt.taxonomy = %s', $taxonomy ); |
1870 |
||
1871 |
if ( ! is_object_in_taxonomy( $post->post_type, $taxonomy ) ) { |
|
1872 |
return ''; |
|
5 | 1873 |
} |
1874 |
$term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); |
|
1875 |
||
1876 |
// Remove any exclusions from the term array to include. |
|
1877 |
$term_array = array_diff( $term_array, (array) $excluded_terms ); |
|
1878 |
$term_array = array_map( 'intval', $term_array ); |
|
1879 |
||
9 | 1880 |
if ( ! $term_array || is_wp_error( $term_array ) ) { |
5 | 1881 |
return ''; |
9 | 1882 |
} |
1883 |
||
1884 |
$where .= ' AND tt.term_id IN (' . implode( ',', $term_array ) . ')'; |
|
5 | 1885 |
} |
1886 |
||
1887 |
if ( ! empty( $excluded_terms ) ) { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1888 |
$where .= " AND p.ID NOT IN ( SELECT tr.object_id FROM $wpdb->term_relationships tr LEFT JOIN $wpdb->term_taxonomy tt ON (tr.term_taxonomy_id = tt.term_taxonomy_id) WHERE tt.term_id IN (" . implode( ',', array_map( 'intval', $excluded_terms ) ) . ') )'; |
5 | 1889 |
} |
1890 |
} |
|
1891 |
||
1892 |
// 'post_status' clause depends on the current user. |
|
1893 |
if ( is_user_logged_in() ) { |
|
1894 |
$user_id = get_current_user_id(); |
|
1895 |
||
1896 |
$post_type_object = get_post_type_object( $post->post_type ); |
|
1897 |
if ( empty( $post_type_object ) ) { |
|
1898 |
$post_type_cap = $post->post_type; |
|
1899 |
$read_private_cap = 'read_private_' . $post_type_cap . 's'; |
|
1900 |
} else { |
|
1901 |
$read_private_cap = $post_type_object->cap->read_private_posts; |
|
1902 |
} |
|
1903 |
||
1904 |
/* |
|
1905 |
* Results should include private posts belonging to the current user, or private posts where the |
|
1906 |
* current user has the 'read_private_posts' cap. |
|
1907 |
*/ |
|
1908 |
$private_states = get_post_stati( array( 'private' => true ) ); |
|
9 | 1909 |
$where .= " AND ( p.post_status = 'publish'"; |
19 | 1910 |
foreach ( $private_states as $state ) { |
5 | 1911 |
if ( current_user_can( $read_private_cap ) ) { |
9 | 1912 |
$where .= $wpdb->prepare( ' OR p.post_status = %s', $state ); |
5 | 1913 |
} else { |
9 | 1914 |
$where .= $wpdb->prepare( ' OR (p.post_author = %d AND p.post_status = %s)', $user_id, $state ); |
0 | 1915 |
} |
1916 |
} |
|
9 | 1917 |
$where .= ' )'; |
5 | 1918 |
} else { |
1919 |
$where .= " AND p.post_status = 'publish'"; |
|
0 | 1920 |
} |
1921 |
||
9 | 1922 |
$op = $previous ? '<' : '>'; |
0 | 1923 |
$order = $previous ? 'DESC' : 'ASC'; |
1924 |
||
5 | 1925 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1926 |
* Filters the JOIN clause in the SQL for an adjacent post query. |
5 | 1927 |
* |
1928 |
* The dynamic portion of the hook name, `$adjacent`, refers to the type |
|
1929 |
* of adjacency, 'next' or 'previous'. |
|
1930 |
* |
|
18 | 1931 |
* Possible hook names include: |
1932 |
* |
|
1933 |
* - `get_next_post_join` |
|
1934 |
* - `get_previous_post_join` |
|
1935 |
* |
|
5 | 1936 |
* @since 2.5.0 |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1937 |
* @since 4.4.0 Added the `$taxonomy` and `$post` parameters. |
5 | 1938 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1939 |
* @param string $join The JOIN clause in the SQL. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1940 |
* @param bool $in_same_term Whether post should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1941 |
* @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1942 |
* @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1943 |
* @param WP_Post $post WP_Post object. |
5 | 1944 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1945 |
$join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms, $taxonomy, $post ); |
5 | 1946 |
|
1947 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1948 |
* Filters the WHERE clause in the SQL for an adjacent post query. |
5 | 1949 |
* |
1950 |
* The dynamic portion of the hook name, `$adjacent`, refers to the type |
|
1951 |
* of adjacency, 'next' or 'previous'. |
|
1952 |
* |
|
18 | 1953 |
* Possible hook names include: |
1954 |
* |
|
1955 |
* - `get_next_post_where` |
|
1956 |
* - `get_previous_post_where` |
|
1957 |
* |
|
5 | 1958 |
* @since 2.5.0 |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1959 |
* @since 4.4.0 Added the `$taxonomy` and `$post` parameters. |
5 | 1960 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1961 |
* @param string $where The `WHERE` clause in the SQL. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1962 |
* @param bool $in_same_term Whether post should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1963 |
* @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1964 |
* @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1965 |
* @param WP_Post $post WP_Post object. |
5 | 1966 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1967 |
$where = apply_filters( "get_{$adjacent}_post_where", $wpdb->prepare( "WHERE p.post_date $op %s AND p.post_type = %s $where", $current_post_date, $post->post_type ), $in_same_term, $excluded_terms, $taxonomy, $post ); |
5 | 1968 |
|
1969 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1970 |
* Filters the ORDER BY clause in the SQL for an adjacent post query. |
5 | 1971 |
* |
1972 |
* The dynamic portion of the hook name, `$adjacent`, refers to the type |
|
1973 |
* of adjacency, 'next' or 'previous'. |
|
1974 |
* |
|
18 | 1975 |
* Possible hook names include: |
1976 |
* |
|
1977 |
* - `get_next_post_sort` |
|
1978 |
* - `get_previous_post_sort` |
|
1979 |
* |
|
5 | 1980 |
* @since 2.5.0 |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1981 |
* @since 4.4.0 Added the `$post` parameter. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1982 |
* @since 4.9.0 Added the `$order` parameter. |
5 | 1983 |
* |
1984 |
* @param string $order_by The `ORDER BY` clause in the SQL. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1985 |
* @param WP_Post $post WP_Post object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1986 |
* @param string $order Sort order. 'DESC' for previous post, 'ASC' for next. |
5 | 1987 |
*/ |
9 | 1988 |
$sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1", $post, $order ); |
1989 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1990 |
$query = "SELECT p.ID FROM $wpdb->posts AS p $join $where $sort"; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1991 |
$key = md5( $query ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1992 |
$last_changed = wp_cache_get_last_changed( 'posts' ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1993 |
if ( $in_same_term || ! empty( $excluded_terms ) ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1994 |
$last_changed .= wp_cache_get_last_changed( 'terms' ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1995 |
} |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1996 |
$cache_key = "adjacent_post:$key:$last_changed"; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1997 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
1998 |
$result = wp_cache_get( $cache_key, 'post-queries' ); |
0 | 1999 |
if ( false !== $result ) { |
9 | 2000 |
if ( $result ) { |
0 | 2001 |
$result = get_post( $result ); |
9 | 2002 |
} |
0 | 2003 |
return $result; |
2004 |
} |
|
2005 |
||
2006 |
$result = $wpdb->get_var( $query ); |
|
9 | 2007 |
if ( null === $result ) { |
0 | 2008 |
$result = ''; |
9 | 2009 |
} |
0 | 2010 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2011 |
wp_cache_set( $cache_key, $result, 'post-queries' ); |
0 | 2012 |
|
9 | 2013 |
if ( $result ) { |
0 | 2014 |
$result = get_post( $result ); |
9 | 2015 |
} |
0 | 2016 |
|
2017 |
return $result; |
|
2018 |
} |
|
2019 |
||
2020 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2021 |
* Retrieves the adjacent post relational link. |
0 | 2022 |
* |
2023 |
* Can either be next or previous post relational link. |
|
2024 |
* |
|
2025 |
* @since 2.8.0 |
|
2026 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2027 |
* @param string $title Optional. Link title format. Default '%title'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2028 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2029 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2030 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2031 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2032 |
* @param bool $previous Optional. Whether to display link to previous or next post. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2033 |
* Default true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2034 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2035 |
* @return string|void The adjacent post relational link URL. |
0 | 2036 |
*/ |
5 | 2037 |
function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { |
16 | 2038 |
$post = get_post(); |
2039 |
if ( $previous && is_attachment() && $post ) { |
|
0 | 2040 |
$post = get_post( $post->post_parent ); |
9 | 2041 |
} else { |
5 | 2042 |
$post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy ); |
9 | 2043 |
} |
2044 |
||
2045 |
if ( empty( $post ) ) { |
|
0 | 2046 |
return; |
9 | 2047 |
} |
2048 |
||
2049 |
$post_title = the_title_attribute( |
|
2050 |
array( |
|
2051 |
'echo' => false, |
|
2052 |
'post' => $post, |
|
2053 |
) |
|
2054 |
); |
|
2055 |
||
2056 |
if ( empty( $post_title ) ) { |
|
5 | 2057 |
$post_title = $previous ? __( 'Previous Post' ) : __( 'Next Post' ); |
9 | 2058 |
} |
5 | 2059 |
|
2060 |
$date = mysql2date( get_option( 'date_format' ), $post->post_date ); |
|
2061 |
||
2062 |
$title = str_replace( '%title', $post_title, $title ); |
|
2063 |
$title = str_replace( '%date', $date, $title ); |
|
0 | 2064 |
|
9 | 2065 |
$link = $previous ? "<link rel='prev' title='" : "<link rel='next' title='"; |
0 | 2066 |
$link .= esc_attr( $title ); |
5 | 2067 |
$link .= "' href='" . get_permalink( $post ) . "' />\n"; |
0 | 2068 |
|
2069 |
$adjacent = $previous ? 'previous' : 'next'; |
|
5 | 2070 |
|
2071 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2072 |
* Filters the adjacent post relational link. |
5 | 2073 |
* |
2074 |
* The dynamic portion of the hook name, `$adjacent`, refers to the type |
|
2075 |
* of adjacency, 'next' or 'previous'. |
|
2076 |
* |
|
18 | 2077 |
* Possible hook names include: |
2078 |
* |
|
2079 |
* - `next_post_rel_link` |
|
2080 |
* - `previous_post_rel_link` |
|
2081 |
* |
|
5 | 2082 |
* @since 2.8.0 |
2083 |
* |
|
2084 |
* @param string $link The relational link. |
|
2085 |
*/ |
|
0 | 2086 |
return apply_filters( "{$adjacent}_post_rel_link", $link ); |
2087 |
} |
|
2088 |
||
2089 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2090 |
* Displays the relational links for the posts adjacent to the current post. |
0 | 2091 |
* |
2092 |
* @since 2.8.0 |
|
2093 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2094 |
* @param string $title Optional. Link title format. Default '%title'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2095 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2096 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2097 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2098 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2099 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
0 | 2100 |
*/ |
5 | 2101 |
function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
2102 |
echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy ); |
|
2103 |
echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy ); |
|
0 | 2104 |
} |
2105 |
||
2106 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2107 |
* Displays relational links for the posts adjacent to the current post for single post pages. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2108 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2109 |
* This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2110 |
* or theme templates. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2111 |
* |
0 | 2112 |
* @since 3.0.0 |
18 | 2113 |
* @since 5.6.0 No longer used in core. |
0 | 2114 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2115 |
* @see adjacent_posts_rel_link() |
0 | 2116 |
*/ |
2117 |
function adjacent_posts_rel_link_wp_head() { |
|
5 | 2118 |
if ( ! is_single() || is_attachment() ) { |
0 | 2119 |
return; |
5 | 2120 |
} |
0 | 2121 |
adjacent_posts_rel_link(); |
2122 |
} |
|
2123 |
||
2124 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2125 |
* Displays the relational link for the next post adjacent to the current post. |
0 | 2126 |
* |
2127 |
* @since 2.8.0 |
|
2128 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2129 |
* @see get_adjacent_post_rel_link() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2130 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2131 |
* @param string $title Optional. Link title format. Default '%title'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2132 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2133 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2134 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2135 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2136 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
0 | 2137 |
*/ |
5 | 2138 |
function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
2139 |
echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy ); |
|
0 | 2140 |
} |
2141 |
||
2142 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2143 |
* Displays the relational link for the previous post adjacent to the current post. |
0 | 2144 |
* |
2145 |
* @since 2.8.0 |
|
2146 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2147 |
* @see get_adjacent_post_rel_link() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2148 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2149 |
* @param string $title Optional. Link title format. Default '%title'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2150 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2151 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2152 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2153 |
* Default true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2154 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
0 | 2155 |
*/ |
5 | 2156 |
function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
2157 |
echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy ); |
|
0 | 2158 |
} |
2159 |
||
2160 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2161 |
* Retrieves the boundary post. |
0 | 2162 |
* |
2163 |
* Boundary being either the first or last post by publish date within the constraints specified |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2164 |
* by `$in_same_term` or `$excluded_terms`. |
0 | 2165 |
* |
2166 |
* @since 2.8.0 |
|
2167 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2168 |
* @param bool $in_same_term Optional. Whether returned post should be in the same taxonomy term. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2169 |
* Default false. |
18 | 2170 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2171 |
* Default empty. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2172 |
* @param bool $start Optional. Whether to retrieve first or last post. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2173 |
* Default true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2174 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2175 |
* @return array|null Array containing the boundary post object if successful, null otherwise. |
0 | 2176 |
*/ |
5 | 2177 |
function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) { |
0 | 2178 |
$post = get_post(); |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2179 |
|
9 | 2180 |
if ( ! $post || ! is_single() || is_attachment() || ! taxonomy_exists( $taxonomy ) ) { |
0 | 2181 |
return null; |
9 | 2182 |
} |
0 | 2183 |
|
5 | 2184 |
$query_args = array( |
9 | 2185 |
'posts_per_page' => 1, |
2186 |
'order' => $start ? 'ASC' : 'DESC', |
|
5 | 2187 |
'update_post_term_cache' => false, |
9 | 2188 |
'update_post_meta_cache' => false, |
5 | 2189 |
); |
2190 |
||
2191 |
$term_array = array(); |
|
2192 |
||
2193 |
if ( ! is_array( $excluded_terms ) ) { |
|
9 | 2194 |
if ( ! empty( $excluded_terms ) ) { |
5 | 2195 |
$excluded_terms = explode( ',', $excluded_terms ); |
9 | 2196 |
} else { |
5 | 2197 |
$excluded_terms = array(); |
9 | 2198 |
} |
5 | 2199 |
} |
2200 |
||
2201 |
if ( $in_same_term || ! empty( $excluded_terms ) ) { |
|
9 | 2202 |
if ( $in_same_term ) { |
5 | 2203 |
$term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); |
9 | 2204 |
} |
5 | 2205 |
|
2206 |
if ( ! empty( $excluded_terms ) ) { |
|
2207 |
$excluded_terms = array_map( 'intval', $excluded_terms ); |
|
2208 |
$excluded_terms = array_diff( $excluded_terms, $term_array ); |
|
2209 |
||
2210 |
$inverse_terms = array(); |
|
9 | 2211 |
foreach ( $excluded_terms as $excluded_term ) { |
5 | 2212 |
$inverse_terms[] = $excluded_term * -1; |
9 | 2213 |
} |
5 | 2214 |
$excluded_terms = $inverse_terms; |
0 | 2215 |
} |
5 | 2216 |
|
9 | 2217 |
$query_args['tax_query'] = array( |
2218 |
array( |
|
2219 |
'taxonomy' => $taxonomy, |
|
2220 |
'terms' => array_merge( $term_array, $excluded_terms ), |
|
2221 |
), |
|
2222 |
); |
|
0 | 2223 |
} |
2224 |
||
5 | 2225 |
return get_posts( $query_args ); |
0 | 2226 |
} |
2227 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2228 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2229 |
* Retrieves the previous post link that is adjacent to the current post. |
0 | 2230 |
* |
2231 |
* @since 3.7.0 |
|
2232 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2233 |
* @param string $format Optional. Link anchor format. Default '« %link'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2234 |
* @param string $link Optional. Link permalink format. Default '%title'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2235 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2236 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2237 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2238 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2239 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
5 | 2240 |
* @return string The link URL of the previous post in relation to the current post. |
0 | 2241 |
*/ |
5 | 2242 |
function get_previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
2243 |
return get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, true, $taxonomy ); |
|
0 | 2244 |
} |
2245 |
||
2246 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2247 |
* Displays the previous post link that is adjacent to the current post. |
0 | 2248 |
* |
2249 |
* @since 1.5.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2250 |
* |
5 | 2251 |
* @see get_previous_post_link() |
0 | 2252 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2253 |
* @param string $format Optional. Link anchor format. Default '« %link'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2254 |
* @param string $link Optional. Link permalink format. Default '%title'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2255 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2256 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2257 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2258 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2259 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
0 | 2260 |
*/ |
5 | 2261 |
function previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
2262 |
echo get_previous_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy ); |
|
0 | 2263 |
} |
2264 |
||
2265 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2266 |
* Retrieves the next post link that is adjacent to the current post. |
0 | 2267 |
* |
2268 |
* @since 3.7.0 |
|
2269 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2270 |
* @param string $format Optional. Link anchor format. Default '« %link'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2271 |
* @param string $link Optional. Link permalink format. Default '%title'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2272 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2273 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2274 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2275 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2276 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
5 | 2277 |
* @return string The link URL of the next post in relation to the current post. |
0 | 2278 |
*/ |
5 | 2279 |
function get_next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
2280 |
return get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, false, $taxonomy ); |
|
0 | 2281 |
} |
2282 |
||
2283 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2284 |
* Displays the next post link that is adjacent to the current post. |
0 | 2285 |
* |
2286 |
* @since 1.5.0 |
|
16 | 2287 |
* |
5 | 2288 |
* @see get_next_post_link() |
0 | 2289 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2290 |
* @param string $format Optional. Link anchor format. Default '« %link'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2291 |
* @param string $link Optional. Link permalink format. Default '%title'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2292 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2293 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2294 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2295 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2296 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
0 | 2297 |
*/ |
5 | 2298 |
function next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { |
9 | 2299 |
echo get_next_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy ); |
0 | 2300 |
} |
2301 |
||
2302 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2303 |
* Retrieves the adjacent post link. |
0 | 2304 |
* |
2305 |
* Can be either next post link or previous. |
|
2306 |
* |
|
2307 |
* @since 3.7.0 |
|
2308 |
* |
|
5 | 2309 |
* @param string $format Link anchor format. |
2310 |
* @param string $link Link permalink format. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2311 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2312 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2313 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2314 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2315 |
* @param bool $previous Optional. Whether to display link to previous or next post. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2316 |
* Default true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2317 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
5 | 2318 |
* @return string The link URL of the previous or next post in relation to the current post. |
0 | 2319 |
*/ |
5 | 2320 |
function get_adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { |
9 | 2321 |
if ( $previous && is_attachment() ) { |
0 | 2322 |
$post = get_post( get_post()->post_parent ); |
9 | 2323 |
} else { |
5 | 2324 |
$post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy ); |
9 | 2325 |
} |
0 | 2326 |
|
2327 |
if ( ! $post ) { |
|
2328 |
$output = ''; |
|
2329 |
} else { |
|
2330 |
$title = $post->post_title; |
|
2331 |
||
9 | 2332 |
if ( empty( $post->post_title ) ) { |
0 | 2333 |
$title = $previous ? __( 'Previous Post' ) : __( 'Next Post' ); |
9 | 2334 |
} |
0 | 2335 |
|
2336 |
/** This filter is documented in wp-includes/post-template.php */ |
|
2337 |
$title = apply_filters( 'the_title', $title, $post->ID ); |
|
5 | 2338 |
|
0 | 2339 |
$date = mysql2date( get_option( 'date_format' ), $post->post_date ); |
9 | 2340 |
$rel = $previous ? 'prev' : 'next'; |
2341 |
||
2342 |
$string = '<a href="' . get_permalink( $post ) . '" rel="' . $rel . '">'; |
|
0 | 2343 |
$inlink = str_replace( '%title', $title, $link ); |
2344 |
$inlink = str_replace( '%date', $date, $inlink ); |
|
2345 |
$inlink = $string . $inlink . '</a>'; |
|
2346 |
||
2347 |
$output = str_replace( '%link', $inlink, $format ); |
|
2348 |
} |
|
2349 |
||
2350 |
$adjacent = $previous ? 'previous' : 'next'; |
|
2351 |
||
5 | 2352 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2353 |
* Filters the adjacent post link. |
5 | 2354 |
* |
2355 |
* The dynamic portion of the hook name, `$adjacent`, refers to the type |
|
2356 |
* of adjacency, 'next' or 'previous'. |
|
2357 |
* |
|
18 | 2358 |
* Possible hook names include: |
2359 |
* |
|
2360 |
* - `next_post_link` |
|
2361 |
* - `previous_post_link` |
|
2362 |
* |
|
5 | 2363 |
* @since 2.6.0 |
2364 |
* @since 4.2.0 Added the `$adjacent` parameter. |
|
2365 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2366 |
* @param string $output The adjacent post link. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2367 |
* @param string $format Link anchor format. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2368 |
* @param string $link Link permalink format. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2369 |
* @param WP_Post|string $post The adjacent post. Empty string if no corresponding post exists. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2370 |
* @param string $adjacent Whether the post is previous or next. |
5 | 2371 |
*/ |
2372 |
return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post, $adjacent ); |
|
0 | 2373 |
} |
2374 |
||
2375 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2376 |
* Displays the adjacent post link. |
0 | 2377 |
* |
2378 |
* Can be either next post link or previous. |
|
2379 |
* |
|
2380 |
* @since 2.5.0 |
|
2381 |
* |
|
5 | 2382 |
* @param string $format Link anchor format. |
2383 |
* @param string $link Link permalink format. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2384 |
* @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2385 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2386 |
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2387 |
* Default empty. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2388 |
* @param bool $previous Optional. Whether to display link to previous or next post. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2389 |
* Default true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2390 |
* @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. |
0 | 2391 |
*/ |
5 | 2392 |
function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { |
2393 |
echo get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, $previous, $taxonomy ); |
|
0 | 2394 |
} |
2395 |
||
2396 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2397 |
* Retrieves the link for a page number. |
0 | 2398 |
* |
2399 |
* @since 1.5.0 |
|
2400 |
* |
|
16 | 2401 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2402 |
* |
9 | 2403 |
* @param int $pagenum Optional. Page number. Default 1. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2404 |
* @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2405 |
* If set to false, prepares the URL with sanitize_url(). Default true. |
5 | 2406 |
* @return string The link URL for the given page number. |
0 | 2407 |
*/ |
9 | 2408 |
function get_pagenum_link( $pagenum = 1, $escape = true ) { |
0 | 2409 |
global $wp_rewrite; |
2410 |
||
2411 |
$pagenum = (int) $pagenum; |
|
2412 |
||
2413 |
$request = remove_query_arg( 'paged' ); |
|
2414 |
||
9 | 2415 |
$home_root = parse_url( home_url() ); |
2416 |
$home_root = ( isset( $home_root['path'] ) ) ? $home_root['path'] : ''; |
|
0 | 2417 |
$home_root = preg_quote( $home_root, '|' ); |
2418 |
||
9 | 2419 |
$request = preg_replace( '|^' . $home_root . '|i', '', $request ); |
2420 |
$request = preg_replace( '|^/+|', '', $request ); |
|
2421 |
||
2422 |
if ( ! $wp_rewrite->using_permalinks() || is_admin() ) { |
|
0 | 2423 |
$base = trailingslashit( get_bloginfo( 'url' ) ); |
2424 |
||
2425 |
if ( $pagenum > 1 ) { |
|
2426 |
$result = add_query_arg( 'paged', $pagenum, $base . $request ); |
|
2427 |
} else { |
|
2428 |
$result = $base . $request; |
|
2429 |
} |
|
2430 |
} else { |
|
2431 |
$qs_regex = '|\?.*?$|'; |
|
2432 |
preg_match( $qs_regex, $request, $qs_match ); |
|
2433 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2434 |
$parts = array(); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2435 |
$parts[] = untrailingslashit( get_bloginfo( 'url' ) ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2436 |
|
9 | 2437 |
if ( ! empty( $qs_match[0] ) ) { |
0 | 2438 |
$query_string = $qs_match[0]; |
9 | 2439 |
$request = preg_replace( $qs_regex, '', $request ); |
0 | 2440 |
} else { |
2441 |
$query_string = ''; |
|
2442 |
} |
|
2443 |
||
9 | 2444 |
$request = preg_replace( "|$wp_rewrite->pagination_base/\d+/?$|", '', $request ); |
2445 |
$request = preg_replace( '|^' . preg_quote( $wp_rewrite->index, '|' ) . '|i', '', $request ); |
|
2446 |
$request = ltrim( $request, '/' ); |
|
0 | 2447 |
|
16 | 2448 |
if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' !== $request ) ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2449 |
$parts[] = $wp_rewrite->index; |
9 | 2450 |
} |
0 | 2451 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2452 |
$parts[] = untrailingslashit( $request ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2453 |
|
0 | 2454 |
if ( $pagenum > 1 ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2455 |
$parts[] = $wp_rewrite->pagination_base; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2456 |
$parts[] = $pagenum; |
0 | 2457 |
} |
2458 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2459 |
$result = user_trailingslashit( implode( '/', array_filter( $parts ) ), 'paged' ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2460 |
if ( ! empty( $query_string ) ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2461 |
$result .= $query_string; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2462 |
} |
0 | 2463 |
} |
2464 |
||
5 | 2465 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2466 |
* Filters the page number link for the current request. |
5 | 2467 |
* |
2468 |
* @since 2.5.0 |
|
9 | 2469 |
* @since 5.2.0 Added the `$pagenum` argument. |
5 | 2470 |
* |
9 | 2471 |
* @param string $result The page number link. |
2472 |
* @param int $pagenum The page number. |
|
5 | 2473 |
*/ |
9 | 2474 |
$result = apply_filters( 'get_pagenum_link', $result, $pagenum ); |
2475 |
||
2476 |
if ( $escape ) { |
|
0 | 2477 |
return esc_url( $result ); |
9 | 2478 |
} else { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2479 |
return sanitize_url( $result ); |
9 | 2480 |
} |
0 | 2481 |
} |
2482 |
||
2483 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2484 |
* Retrieves the next posts page link. |
0 | 2485 |
* |
2486 |
* Backported from 2.1.3 to 2.0.10. |
|
2487 |
* |
|
2488 |
* @since 2.0.10 |
|
2489 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2490 |
* @global int $paged |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2491 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2492 |
* @param int $max_page Optional. Max pages. Default 0. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2493 |
* @return string|void The link URL for next posts page. |
0 | 2494 |
*/ |
9 | 2495 |
function get_next_posts_page_link( $max_page = 0 ) { |
0 | 2496 |
global $paged; |
2497 |
||
9 | 2498 |
if ( ! is_single() ) { |
2499 |
if ( ! $paged ) { |
|
0 | 2500 |
$paged = 1; |
9 | 2501 |
} |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2502 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2503 |
$next_page = (int) $paged + 1; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2504 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2505 |
if ( ! $max_page || $max_page >= $next_page ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2506 |
return get_pagenum_link( $next_page ); |
9 | 2507 |
} |
0 | 2508 |
} |
2509 |
} |
|
2510 |
||
2511 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2512 |
* Displays or retrieves the next posts page link. |
0 | 2513 |
* |
2514 |
* @since 0.71 |
|
2515 |
* |
|
16 | 2516 |
* @param int $max_page Optional. Max pages. Default 0. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2517 |
* @param bool $display Optional. Whether to echo the link. Default true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2518 |
* @return string|void The link URL for next posts page if `$display = false`. |
0 | 2519 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2520 |
function next_posts( $max_page = 0, $display = true ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2521 |
$link = get_next_posts_page_link( $max_page ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2522 |
$output = $link ? esc_url( $link ) : ''; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2523 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2524 |
if ( $display ) { |
0 | 2525 |
echo $output; |
9 | 2526 |
} else { |
0 | 2527 |
return $output; |
9 | 2528 |
} |
0 | 2529 |
} |
2530 |
||
2531 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2532 |
* Retrieves the next posts page link. |
0 | 2533 |
* |
2534 |
* @since 2.7.0 |
|
2535 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2536 |
* @global int $paged |
16 | 2537 |
* @global WP_Query $wp_query WordPress Query object. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2538 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2539 |
* @param string $label Content for link text. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2540 |
* @param int $max_page Optional. Max pages. Default 0. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2541 |
* @return string|void HTML-formatted next posts page link. |
0 | 2542 |
*/ |
2543 |
function get_next_posts_link( $label = null, $max_page = 0 ) { |
|
2544 |
global $paged, $wp_query; |
|
2545 |
||
9 | 2546 |
if ( ! $max_page ) { |
0 | 2547 |
$max_page = $wp_query->max_num_pages; |
9 | 2548 |
} |
2549 |
||
2550 |
if ( ! $paged ) { |
|
0 | 2551 |
$paged = 1; |
9 | 2552 |
} |
2553 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2554 |
$next_page = (int) $paged + 1; |
9 | 2555 |
|
2556 |
if ( null === $label ) { |
|
0 | 2557 |
$label = __( 'Next Page »' ); |
9 | 2558 |
} |
2559 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2560 |
if ( ! is_single() && ( $next_page <= $max_page ) ) { |
5 | 2561 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2562 |
* Filters the anchor tag attributes for the next posts page link. |
5 | 2563 |
* |
2564 |
* @since 2.7.0 |
|
2565 |
* |
|
2566 |
* @param string $attributes Attributes for the anchor tag. |
|
2567 |
*/ |
|
0 | 2568 |
$attr = apply_filters( 'next_posts_link_attributes', '' ); |
5 | 2569 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2570 |
return sprintf( |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2571 |
'<a href="%1$s" %2$s>%3$s</a>', |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2572 |
next_posts( $max_page, false ), |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2573 |
$attr, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2574 |
preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2575 |
); |
0 | 2576 |
} |
2577 |
} |
|
2578 |
||
2579 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2580 |
* Displays the next posts page link. |
0 | 2581 |
* |
2582 |
* @since 0.71 |
|
2583 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2584 |
* @param string $label Content for link text. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2585 |
* @param int $max_page Optional. Max pages. Default 0. |
0 | 2586 |
*/ |
2587 |
function next_posts_link( $label = null, $max_page = 0 ) { |
|
2588 |
echo get_next_posts_link( $label, $max_page ); |
|
2589 |
} |
|
2590 |
||
2591 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2592 |
* Retrieves the previous posts page link. |
0 | 2593 |
* |
2594 |
* Will only return string, if not on a single page or post. |
|
2595 |
* |
|
2596 |
* Backported to 2.0.10 from 2.1.3. |
|
2597 |
* |
|
2598 |
* @since 2.0.10 |
|
2599 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2600 |
* @global int $paged |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2601 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2602 |
* @return string|void The link for the previous posts page. |
0 | 2603 |
*/ |
2604 |
function get_previous_posts_page_link() { |
|
2605 |
global $paged; |
|
2606 |
||
9 | 2607 |
if ( ! is_single() ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2608 |
$previous_page = (int) $paged - 1; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2609 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2610 |
if ( $previous_page < 1 ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2611 |
$previous_page = 1; |
9 | 2612 |
} |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2613 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2614 |
return get_pagenum_link( $previous_page ); |
0 | 2615 |
} |
2616 |
} |
|
2617 |
||
2618 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2619 |
* Displays or retrieves the previous posts page link. |
0 | 2620 |
* |
2621 |
* @since 0.71 |
|
2622 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2623 |
* @param bool $display Optional. Whether to echo the link. Default true. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2624 |
* @return string|void The previous posts page link if `$display = false`. |
0 | 2625 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2626 |
function previous_posts( $display = true ) { |
0 | 2627 |
$output = esc_url( get_previous_posts_page_link() ); |
2628 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2629 |
if ( $display ) { |
0 | 2630 |
echo $output; |
9 | 2631 |
} else { |
0 | 2632 |
return $output; |
9 | 2633 |
} |
0 | 2634 |
} |
2635 |
||
2636 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2637 |
* Retrieves the previous posts page link. |
0 | 2638 |
* |
2639 |
* @since 2.7.0 |
|
2640 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2641 |
* @global int $paged |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2642 |
* |
0 | 2643 |
* @param string $label Optional. Previous page link text. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2644 |
* @return string|void HTML-formatted previous page link. |
0 | 2645 |
*/ |
2646 |
function get_previous_posts_link( $label = null ) { |
|
2647 |
global $paged; |
|
2648 |
||
9 | 2649 |
if ( null === $label ) { |
0 | 2650 |
$label = __( '« Previous Page' ); |
9 | 2651 |
} |
2652 |
||
2653 |
if ( ! is_single() && $paged > 1 ) { |
|
5 | 2654 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2655 |
* Filters the anchor tag attributes for the previous posts page link. |
5 | 2656 |
* |
2657 |
* @since 2.7.0 |
|
2658 |
* |
|
2659 |
* @param string $attributes Attributes for the anchor tag. |
|
2660 |
*/ |
|
0 | 2661 |
$attr = apply_filters( 'previous_posts_link_attributes', '' ); |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2662 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2663 |
return sprintf( |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2664 |
'<a href="%1$s" %2$s>%3$s</a>', |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2665 |
previous_posts( false ), |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2666 |
$attr, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2667 |
preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2668 |
); |
0 | 2669 |
} |
2670 |
} |
|
2671 |
||
2672 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2673 |
* Displays the previous posts page link. |
0 | 2674 |
* |
2675 |
* @since 0.71 |
|
2676 |
* |
|
2677 |
* @param string $label Optional. Previous page link text. |
|
2678 |
*/ |
|
2679 |
function previous_posts_link( $label = null ) { |
|
2680 |
echo get_previous_posts_link( $label ); |
|
2681 |
} |
|
2682 |
||
2683 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2684 |
* Retrieves the post pages link navigation for previous and next pages. |
0 | 2685 |
* |
5 | 2686 |
* @since 2.8.0 |
0 | 2687 |
* |
16 | 2688 |
* @global WP_Query $wp_query WordPress Query object. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2689 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2690 |
* @param string|array $args { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2691 |
* Optional. Arguments to build the post pages link navigation. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2692 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2693 |
* @type string $sep Separator character. Default '—'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2694 |
* @type string $prelabel Link text to display for the previous page link. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2695 |
* Default '« Previous Page'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2696 |
* @type string $nxtlabel Link text to display for the next page link. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2697 |
* Default 'Next Page »'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2698 |
* } |
0 | 2699 |
* @return string The posts link navigation. |
2700 |
*/ |
|
2701 |
function get_posts_nav_link( $args = array() ) { |
|
2702 |
global $wp_query; |
|
2703 |
||
2704 |
$return = ''; |
|
2705 |
||
9 | 2706 |
if ( ! is_singular() ) { |
0 | 2707 |
$defaults = array( |
9 | 2708 |
'sep' => ' — ', |
2709 |
'prelabel' => __( '« Previous Page' ), |
|
2710 |
'nxtlabel' => __( 'Next Page »' ), |
|
0 | 2711 |
); |
9 | 2712 |
$args = wp_parse_args( $args, $defaults ); |
0 | 2713 |
|
2714 |
$max_num_pages = $wp_query->max_num_pages; |
|
9 | 2715 |
$paged = get_query_var( 'paged' ); |
0 | 2716 |
|
16 | 2717 |
// Only have sep if there's both prev and next results. |
9 | 2718 |
if ( $paged < 2 || $paged >= $max_num_pages ) { |
0 | 2719 |
$args['sep'] = ''; |
2720 |
} |
|
2721 |
||
2722 |
if ( $max_num_pages > 1 ) { |
|
9 | 2723 |
$return = get_previous_posts_link( $args['prelabel'] ); |
2724 |
$return .= preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $args['sep'] ); |
|
2725 |
$return .= get_next_posts_link( $args['nxtlabel'] ); |
|
0 | 2726 |
} |
2727 |
} |
|
2728 |
return $return; |
|
2729 |
} |
|
2730 |
||
2731 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2732 |
* Displays the post pages link navigation for previous and next pages. |
0 | 2733 |
* |
2734 |
* @since 0.71 |
|
2735 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2736 |
* @param string $sep Optional. Separator for posts navigation links. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2737 |
* @param string $prelabel Optional. Label for previous pages. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2738 |
* @param string $nxtlabel Optional Label for next pages. Default empty. |
0 | 2739 |
*/ |
2740 |
function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) { |
|
9 | 2741 |
$args = array_filter( compact( 'sep', 'prelabel', 'nxtlabel' ) ); |
2742 |
echo get_posts_nav_link( $args ); |
|
0 | 2743 |
} |
2744 |
||
2745 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2746 |
* Retrieves the navigation to next/previous post, when applicable. |
5 | 2747 |
* |
2748 |
* @since 4.1.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2749 |
* @since 4.4.0 Introduced the `in_same_term`, `excluded_terms`, and `taxonomy` arguments. |
16 | 2750 |
* @since 5.3.0 Added the `aria_label` parameter. |
2751 |
* @since 5.5.0 Added the `class` parameter. |
|
5 | 2752 |
* |
2753 |
* @param array $args { |
|
2754 |
* Optional. Default post navigation arguments. Default empty array. |
|
2755 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2756 |
* @type string $prev_text Anchor text to display in the previous post link. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2757 |
* Default '%title'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2758 |
* @type string $next_text Anchor text to display in the next post link. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2759 |
* Default '%title'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2760 |
* @type bool $in_same_term Whether link should be in the same taxonomy term. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2761 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2762 |
* @type int[]|string $excluded_terms Array or comma-separated list of excluded term IDs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2763 |
* Default empty. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2764 |
* @type string $taxonomy Taxonomy, if `$in_same_term` is true. Default 'category'. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2765 |
* @type string $screen_reader_text Screen reader text for the nav element. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2766 |
* Default 'Post navigation'. |
16 | 2767 |
* @type string $aria_label ARIA label text for the nav element. Default 'Posts'. |
2768 |
* @type string $class Custom class for the nav element. Default 'post-navigation'. |
|
5 | 2769 |
* } |
2770 |
* @return string Markup for post links. |
|
2771 |
*/ |
|
2772 |
function get_the_post_navigation( $args = array() ) { |
|
16 | 2773 |
// Make sure the nav element has an aria-label attribute: fallback to the screen reader text. |
2774 |
if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { |
|
2775 |
$args['aria_label'] = $args['screen_reader_text']; |
|
2776 |
} |
|
2777 |
||
9 | 2778 |
$args = wp_parse_args( |
2779 |
$args, |
|
2780 |
array( |
|
2781 |
'prev_text' => '%title', |
|
2782 |
'next_text' => '%title', |
|
2783 |
'in_same_term' => false, |
|
2784 |
'excluded_terms' => '', |
|
2785 |
'taxonomy' => 'category', |
|
2786 |
'screen_reader_text' => __( 'Post navigation' ), |
|
16 | 2787 |
'aria_label' => __( 'Posts' ), |
2788 |
'class' => 'post-navigation', |
|
9 | 2789 |
) |
2790 |
); |
|
5 | 2791 |
|
2792 |
$navigation = ''; |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2793 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2794 |
$previous = get_previous_post_link( |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2795 |
'<div class="nav-previous">%link</div>', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2796 |
$args['prev_text'], |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2797 |
$args['in_same_term'], |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2798 |
$args['excluded_terms'], |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2799 |
$args['taxonomy'] |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2800 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2801 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2802 |
$next = get_next_post_link( |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2803 |
'<div class="nav-next">%link</div>', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2804 |
$args['next_text'], |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2805 |
$args['in_same_term'], |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2806 |
$args['excluded_terms'], |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2807 |
$args['taxonomy'] |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2808 |
); |
5 | 2809 |
|
2810 |
// Only add markup if there's somewhere to navigate to. |
|
2811 |
if ( $previous || $next ) { |
|
16 | 2812 |
$navigation = _navigation_markup( $previous . $next, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); |
5 | 2813 |
} |
2814 |
||
2815 |
return $navigation; |
|
2816 |
} |
|
2817 |
||
2818 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2819 |
* Displays the navigation to next/previous post, when applicable. |
5 | 2820 |
* |
2821 |
* @since 4.1.0 |
|
2822 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2823 |
* @param array $args Optional. See get_the_post_navigation() for available arguments. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2824 |
* Default empty array. |
5 | 2825 |
*/ |
2826 |
function the_post_navigation( $args = array() ) { |
|
2827 |
echo get_the_post_navigation( $args ); |
|
2828 |
} |
|
2829 |
||
2830 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2831 |
* Returns the navigation to next/previous set of posts, when applicable. |
5 | 2832 |
* |
2833 |
* @since 4.1.0 |
|
16 | 2834 |
* @since 5.3.0 Added the `aria_label` parameter. |
2835 |
* @since 5.5.0 Added the `class` parameter. |
|
5 | 2836 |
* |
2837 |
* @global WP_Query $wp_query WordPress Query object. |
|
2838 |
* |
|
2839 |
* @param array $args { |
|
2840 |
* Optional. Default posts navigation arguments. Default empty array. |
|
2841 |
* |
|
2842 |
* @type string $prev_text Anchor text to display in the previous posts link. |
|
2843 |
* Default 'Older posts'. |
|
2844 |
* @type string $next_text Anchor text to display in the next posts link. |
|
2845 |
* Default 'Newer posts'. |
|
16 | 2846 |
* @type string $screen_reader_text Screen reader text for the nav element. |
5 | 2847 |
* Default 'Posts navigation'. |
16 | 2848 |
* @type string $aria_label ARIA label text for the nav element. Default 'Posts'. |
2849 |
* @type string $class Custom class for the nav element. Default 'posts-navigation'. |
|
5 | 2850 |
* } |
2851 |
* @return string Markup for posts links. |
|
2852 |
*/ |
|
2853 |
function get_the_posts_navigation( $args = array() ) { |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2854 |
global $wp_query; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2855 |
|
5 | 2856 |
$navigation = ''; |
2857 |
||
2858 |
// Don't print empty markup if there's only one page. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2859 |
if ( $wp_query->max_num_pages > 1 ) { |
16 | 2860 |
// Make sure the nav element has an aria-label attribute: fallback to the screen reader text. |
2861 |
if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { |
|
2862 |
$args['aria_label'] = $args['screen_reader_text']; |
|
2863 |
} |
|
2864 |
||
9 | 2865 |
$args = wp_parse_args( |
2866 |
$args, |
|
2867 |
array( |
|
2868 |
'prev_text' => __( 'Older posts' ), |
|
2869 |
'next_text' => __( 'Newer posts' ), |
|
2870 |
'screen_reader_text' => __( 'Posts navigation' ), |
|
16 | 2871 |
'aria_label' => __( 'Posts' ), |
2872 |
'class' => 'posts-navigation', |
|
9 | 2873 |
) |
2874 |
); |
|
5 | 2875 |
|
2876 |
$next_link = get_previous_posts_link( $args['next_text'] ); |
|
2877 |
$prev_link = get_next_posts_link( $args['prev_text'] ); |
|
2878 |
||
2879 |
if ( $prev_link ) { |
|
2880 |
$navigation .= '<div class="nav-previous">' . $prev_link . '</div>'; |
|
2881 |
} |
|
2882 |
||
2883 |
if ( $next_link ) { |
|
2884 |
$navigation .= '<div class="nav-next">' . $next_link . '</div>'; |
|
2885 |
} |
|
2886 |
||
16 | 2887 |
$navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); |
5 | 2888 |
} |
2889 |
||
2890 |
return $navigation; |
|
2891 |
} |
|
2892 |
||
2893 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2894 |
* Displays the navigation to next/previous set of posts, when applicable. |
5 | 2895 |
* |
2896 |
* @since 4.1.0 |
|
2897 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2898 |
* @param array $args Optional. See get_the_posts_navigation() for available arguments. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2899 |
* Default empty array. |
5 | 2900 |
*/ |
2901 |
function the_posts_navigation( $args = array() ) { |
|
2902 |
echo get_the_posts_navigation( $args ); |
|
2903 |
} |
|
2904 |
||
2905 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2906 |
* Retrieves a paginated navigation to next/previous set of posts, when applicable. |
5 | 2907 |
* |
2908 |
* @since 4.1.0 |
|
16 | 2909 |
* @since 5.3.0 Added the `aria_label` parameter. |
2910 |
* @since 5.5.0 Added the `class` parameter. |
|
5 | 2911 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2912 |
* @global WP_Query $wp_query WordPress Query object. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2913 |
* |
5 | 2914 |
* @param array $args { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2915 |
* Optional. Default pagination arguments, see paginate_links(). |
5 | 2916 |
* |
2917 |
* @type string $screen_reader_text Screen reader text for navigation element. |
|
2918 |
* Default 'Posts navigation'. |
|
16 | 2919 |
* @type string $aria_label ARIA label text for the nav element. Default 'Posts'. |
2920 |
* @type string $class Custom class for the nav element. Default 'pagination'. |
|
5 | 2921 |
* } |
2922 |
* @return string Markup for pagination links. |
|
2923 |
*/ |
|
2924 |
function get_the_posts_pagination( $args = array() ) { |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2925 |
global $wp_query; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2926 |
|
5 | 2927 |
$navigation = ''; |
2928 |
||
2929 |
// Don't print empty markup if there's only one page. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2930 |
if ( $wp_query->max_num_pages > 1 ) { |
16 | 2931 |
// Make sure the nav element has an aria-label attribute: fallback to the screen reader text. |
2932 |
if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { |
|
2933 |
$args['aria_label'] = $args['screen_reader_text']; |
|
2934 |
} |
|
2935 |
||
9 | 2936 |
$args = wp_parse_args( |
2937 |
$args, |
|
2938 |
array( |
|
2939 |
'mid_size' => 1, |
|
2940 |
'prev_text' => _x( 'Previous', 'previous set of posts' ), |
|
2941 |
'next_text' => _x( 'Next', 'next set of posts' ), |
|
2942 |
'screen_reader_text' => __( 'Posts navigation' ), |
|
16 | 2943 |
'aria_label' => __( 'Posts' ), |
2944 |
'class' => 'pagination', |
|
9 | 2945 |
) |
2946 |
); |
|
5 | 2947 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2948 |
/** |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2949 |
* Filters the arguments for posts pagination links. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2950 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2951 |
* @since 6.1.0 |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2952 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2953 |
* @param array $args { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2954 |
* Optional. Default pagination arguments, see paginate_links(). |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2955 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2956 |
* @type string $screen_reader_text Screen reader text for navigation element. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2957 |
* Default 'Posts navigation'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2958 |
* @type string $aria_label ARIA label text for the nav element. Default 'Posts'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2959 |
* @type string $class Custom class for the nav element. Default 'pagination'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2960 |
* } |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2961 |
*/ |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2962 |
$args = apply_filters( 'the_posts_pagination_args', $args ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
2963 |
|
5 | 2964 |
// Make sure we get a string back. Plain is the next best thing. |
16 | 2965 |
if ( isset( $args['type'] ) && 'array' === $args['type'] ) { |
5 | 2966 |
$args['type'] = 'plain'; |
2967 |
} |
|
2968 |
||
2969 |
// Set up paginated links. |
|
2970 |
$links = paginate_links( $args ); |
|
2971 |
||
2972 |
if ( $links ) { |
|
16 | 2973 |
$navigation = _navigation_markup( $links, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); |
5 | 2974 |
} |
2975 |
} |
|
2976 |
||
2977 |
return $navigation; |
|
2978 |
} |
|
2979 |
||
2980 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2981 |
* Displays a paginated navigation to next/previous set of posts, when applicable. |
5 | 2982 |
* |
2983 |
* @since 4.1.0 |
|
2984 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2985 |
* @param array $args Optional. See get_the_posts_pagination() for available arguments. |
5 | 2986 |
* Default empty array. |
2987 |
*/ |
|
2988 |
function the_posts_pagination( $args = array() ) { |
|
2989 |
echo get_the_posts_pagination( $args ); |
|
2990 |
} |
|
2991 |
||
2992 |
/** |
|
2993 |
* Wraps passed links in navigational markup. |
|
2994 |
* |
|
2995 |
* @since 4.1.0 |
|
16 | 2996 |
* @since 5.3.0 Added the `aria_label` parameter. |
5 | 2997 |
* @access private |
2998 |
* |
|
2999 |
* @param string $links Navigational links. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3000 |
* @param string $css_class Optional. Custom class for the nav element. |
16 | 3001 |
* Default 'posts-navigation'. |
3002 |
* @param string $screen_reader_text Optional. Screen reader text for the nav element. |
|
3003 |
* Default 'Posts navigation'. |
|
3004 |
* @param string $aria_label Optional. ARIA label for the nav element. |
|
3005 |
* Defaults to the value of `$screen_reader_text`. |
|
5 | 3006 |
* @return string Navigation template tag. |
3007 |
*/ |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3008 |
function _navigation_markup( $links, $css_class = 'posts-navigation', $screen_reader_text = '', $aria_label = '' ) { |
5 | 3009 |
if ( empty( $screen_reader_text ) ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3010 |
$screen_reader_text = /* translators: Hidden accessibility text. */ __( 'Posts navigation' ); |
5 | 3011 |
} |
16 | 3012 |
if ( empty( $aria_label ) ) { |
3013 |
$aria_label = $screen_reader_text; |
|
3014 |
} |
|
5 | 3015 |
|
3016 |
$template = ' |
|
19 | 3017 |
<nav class="navigation %1$s" aria-label="%4$s"> |
5 | 3018 |
<h2 class="screen-reader-text">%2$s</h2> |
3019 |
<div class="nav-links">%3$s</div> |
|
3020 |
</nav>'; |
|
3021 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3022 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3023 |
* Filters the navigation markup template. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3024 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3025 |
* Note: The filtered template HTML must contain specifiers for the navigation |
16 | 3026 |
* class (%1$s), the screen-reader-text value (%2$s), placement of the navigation |
3027 |
* links (%3$s), and ARIA label text if screen-reader-text does not fit that (%4$s): |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3028 |
* |
19 | 3029 |
* <nav class="navigation %1$s" aria-label="%4$s"> |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3030 |
* <h2 class="screen-reader-text">%2$s</h2> |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3031 |
* <div class="nav-links">%3$s</div> |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3032 |
* </nav> |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3033 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3034 |
* @since 4.4.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3035 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3036 |
* @param string $template The default template. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3037 |
* @param string $css_class The class passed by the calling function. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3038 |
* @return string Navigation template. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3039 |
*/ |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3040 |
$template = apply_filters( 'navigation_markup_template', $template, $css_class ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3041 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3042 |
return sprintf( $template, sanitize_html_class( $css_class ), esc_html( $screen_reader_text ), $links, esc_attr( $aria_label ) ); |
5 | 3043 |
} |
3044 |
||
3045 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3046 |
* Retrieves the comments page number link. |
0 | 3047 |
* |
3048 |
* @since 2.7.0 |
|
3049 |
* |
|
16 | 3050 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3051 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3052 |
* @param int $pagenum Optional. Page number. Default 1. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3053 |
* @param int $max_page Optional. The maximum number of comment pages. Default 0. |
5 | 3054 |
* @return string The comments page number link URL. |
0 | 3055 |
*/ |
3056 |
function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) { |
|
3057 |
global $wp_rewrite; |
|
3058 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3059 |
$pagenum = (int) $pagenum; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3060 |
$max_page = (int) $max_page; |
0 | 3061 |
|
3062 |
$result = get_permalink(); |
|
3063 |
||
16 | 3064 |
if ( 'newest' === get_option( 'default_comments_page' ) ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3065 |
if ( $pagenum !== $max_page ) { |
9 | 3066 |
if ( $wp_rewrite->using_permalinks() ) { |
3067 |
$result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' ); |
|
3068 |
} else { |
|
0 | 3069 |
$result = add_query_arg( 'cpage', $pagenum, $result ); |
9 | 3070 |
} |
0 | 3071 |
} |
3072 |
} elseif ( $pagenum > 1 ) { |
|
9 | 3073 |
if ( $wp_rewrite->using_permalinks() ) { |
3074 |
$result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' ); |
|
3075 |
} else { |
|
0 | 3076 |
$result = add_query_arg( 'cpage', $pagenum, $result ); |
9 | 3077 |
} |
0 | 3078 |
} |
3079 |
||
3080 |
$result .= '#comments'; |
|
3081 |
||
5 | 3082 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3083 |
* Filters the comments page number link for the current request. |
5 | 3084 |
* |
3085 |
* @since 2.7.0 |
|
3086 |
* |
|
3087 |
* @param string $result The comments page number link. |
|
3088 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3089 |
return apply_filters( 'get_comments_pagenum_link', $result ); |
0 | 3090 |
} |
3091 |
||
3092 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3093 |
* Retrieves the link to the next comments page. |
0 | 3094 |
* |
3095 |
* @since 2.7.1 |
|
3096 |
* |
|
16 | 3097 |
* @global WP_Query $wp_query WordPress Query object. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3098 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3099 |
* @param string $label Optional. Label for link text. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3100 |
* @param int $max_page Optional. Max page. Default 0. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3101 |
* @return string|void HTML-formatted link for the next page of comments. |
0 | 3102 |
*/ |
3103 |
function get_next_comments_link( $label = '', $max_page = 0 ) { |
|
3104 |
global $wp_query; |
|
3105 |
||
9 | 3106 |
if ( ! is_singular() ) { |
0 | 3107 |
return; |
9 | 3108 |
} |
3109 |
||
3110 |
$page = get_query_var( 'cpage' ); |
|
0 | 3111 |
|
5 | 3112 |
if ( ! $page ) { |
3113 |
$page = 1; |
|
3114 |
} |
|
3115 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3116 |
$next_page = (int) $page + 1; |
9 | 3117 |
|
3118 |
if ( empty( $max_page ) ) { |
|
0 | 3119 |
$max_page = $wp_query->max_num_comment_pages; |
9 | 3120 |
} |
3121 |
||
3122 |
if ( empty( $max_page ) ) { |
|
0 | 3123 |
$max_page = get_comment_pages_count(); |
9 | 3124 |
} |
3125 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3126 |
if ( $next_page > $max_page ) { |
0 | 3127 |
return; |
9 | 3128 |
} |
3129 |
||
3130 |
if ( empty( $label ) ) { |
|
3131 |
$label = __( 'Newer Comments »' ); |
|
3132 |
} |
|
0 | 3133 |
|
5 | 3134 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3135 |
* Filters the anchor tag attributes for the next comments page link. |
5 | 3136 |
* |
3137 |
* @since 2.7.0 |
|
3138 |
* |
|
3139 |
* @param string $attributes Attributes for the anchor tag. |
|
3140 |
*/ |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3141 |
$attr = apply_filters( 'next_comments_link_attributes', '' ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3142 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3143 |
return sprintf( |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3144 |
'<a href="%1$s" %2$s>%3$s</a>', |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3145 |
esc_url( get_comments_pagenum_link( $next_page, $max_page ) ), |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3146 |
$attr, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3147 |
preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3148 |
); |
0 | 3149 |
} |
3150 |
||
3151 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3152 |
* Displays the link to the next comments page. |
0 | 3153 |
* |
3154 |
* @since 2.7.0 |
|
3155 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3156 |
* @param string $label Optional. Label for link text. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3157 |
* @param int $max_page Optional. Max page. Default 0. |
0 | 3158 |
*/ |
3159 |
function next_comments_link( $label = '', $max_page = 0 ) { |
|
3160 |
echo get_next_comments_link( $label, $max_page ); |
|
3161 |
} |
|
3162 |
||
3163 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3164 |
* Retrieves the link to the previous comments page. |
0 | 3165 |
* |
3166 |
* @since 2.7.1 |
|
3167 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3168 |
* @param string $label Optional. Label for comments link text. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3169 |
* @return string|void HTML-formatted link for the previous page of comments. |
0 | 3170 |
*/ |
3171 |
function get_previous_comments_link( $label = '' ) { |
|
9 | 3172 |
if ( ! is_singular() ) { |
3173 |
return; |
|
3174 |
} |
|
3175 |
||
3176 |
$page = get_query_var( 'cpage' ); |
|
3177 |
||
18 | 3178 |
if ( (int) $page <= 1 ) { |
0 | 3179 |
return; |
9 | 3180 |
} |
3181 |
||
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3182 |
$previous_page = (int) $page - 1; |
9 | 3183 |
|
3184 |
if ( empty( $label ) ) { |
|
3185 |
$label = __( '« Older Comments' ); |
|
3186 |
} |
|
0 | 3187 |
|
5 | 3188 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3189 |
* Filters the anchor tag attributes for the previous comments page link. |
5 | 3190 |
* |
3191 |
* @since 2.7.0 |
|
3192 |
* |
|
3193 |
* @param string $attributes Attributes for the anchor tag. |
|
3194 |
*/ |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3195 |
$attr = apply_filters( 'previous_comments_link_attributes', '' ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3196 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3197 |
return sprintf( |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3198 |
'<a href="%1$s" %2$s>%3$s</a>', |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3199 |
esc_url( get_comments_pagenum_link( $previous_page ) ), |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3200 |
$attr, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3201 |
preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3202 |
); |
0 | 3203 |
} |
3204 |
||
3205 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3206 |
* Displays the link to the previous comments page. |
0 | 3207 |
* |
3208 |
* @since 2.7.0 |
|
3209 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3210 |
* @param string $label Optional. Label for comments link text. Default empty. |
0 | 3211 |
*/ |
3212 |
function previous_comments_link( $label = '' ) { |
|
3213 |
echo get_previous_comments_link( $label ); |
|
3214 |
} |
|
3215 |
||
3216 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3217 |
* Displays or retrieves pagination links for the comments on the current post. |
0 | 3218 |
* |
3219 |
* @see paginate_links() |
|
3220 |
* @since 2.7.0 |
|
3221 |
* |
|
16 | 3222 |
* @global WP_Rewrite $wp_rewrite WordPress rewrite component. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3223 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3224 |
* @param string|array $args Optional args. See paginate_links(). Default empty array. |
16 | 3225 |
* @return void|string|array Void if 'echo' argument is true and 'type' is not an array, |
3226 |
* or if the query is not for an existing single post of any post type. |
|
3227 |
* Otherwise, markup for comment page links or array of comment page links, |
|
3228 |
* depending on 'type' argument. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3229 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3230 |
function paginate_comments_links( $args = array() ) { |
0 | 3231 |
global $wp_rewrite; |
3232 |
||
9 | 3233 |
if ( ! is_singular() ) { |
0 | 3234 |
return; |
9 | 3235 |
} |
3236 |
||
3237 |
$page = get_query_var( 'cpage' ); |
|
3238 |
if ( ! $page ) { |
|
0 | 3239 |
$page = 1; |
9 | 3240 |
} |
0 | 3241 |
$max_page = get_comment_pages_count(); |
3242 |
$defaults = array( |
|
9 | 3243 |
'base' => add_query_arg( 'cpage', '%#%' ), |
3244 |
'format' => '', |
|
3245 |
'total' => $max_page, |
|
3246 |
'current' => $page, |
|
3247 |
'echo' => true, |
|
3248 |
'type' => 'plain', |
|
3249 |
'add_fragment' => '#comments', |
|
0 | 3250 |
); |
9 | 3251 |
if ( $wp_rewrite->using_permalinks() ) { |
3252 |
$defaults['base'] = user_trailingslashit( trailingslashit( get_permalink() ) . $wp_rewrite->comments_pagination_base . '-%#%', 'commentpaged' ); |
|
3253 |
} |
|
3254 |
||
3255 |
$args = wp_parse_args( $args, $defaults ); |
|
0 | 3256 |
$page_links = paginate_links( $args ); |
3257 |
||
9 | 3258 |
if ( $args['echo'] && 'array' !== $args['type'] ) { |
0 | 3259 |
echo $page_links; |
9 | 3260 |
} else { |
0 | 3261 |
return $page_links; |
9 | 3262 |
} |
0 | 3263 |
} |
3264 |
||
3265 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3266 |
* Retrieves navigation to next/previous set of comments, when applicable. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3267 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3268 |
* @since 4.4.0 |
16 | 3269 |
* @since 5.3.0 Added the `aria_label` parameter. |
3270 |
* @since 5.5.0 Added the `class` parameter. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3271 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3272 |
* @param array $args { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3273 |
* Optional. Default comments navigation arguments. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3274 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3275 |
* @type string $prev_text Anchor text to display in the previous comments link. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3276 |
* Default 'Older comments'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3277 |
* @type string $next_text Anchor text to display in the next comments link. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3278 |
* Default 'Newer comments'. |
16 | 3279 |
* @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'. |
3280 |
* @type string $aria_label ARIA label text for the nav element. Default 'Comments'. |
|
3281 |
* @type string $class Custom class for the nav element. Default 'comment-navigation'. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3282 |
* } |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3283 |
* @return string Markup for comments links. |
0 | 3284 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3285 |
function get_the_comments_navigation( $args = array() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3286 |
$navigation = ''; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3287 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3288 |
// Are there comments to navigate through? |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3289 |
if ( get_comment_pages_count() > 1 ) { |
16 | 3290 |
// Make sure the nav element has an aria-label attribute: fallback to the screen reader text. |
3291 |
if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { |
|
3292 |
$args['aria_label'] = $args['screen_reader_text']; |
|
3293 |
} |
|
3294 |
||
9 | 3295 |
$args = wp_parse_args( |
3296 |
$args, |
|
3297 |
array( |
|
3298 |
'prev_text' => __( 'Older comments' ), |
|
3299 |
'next_text' => __( 'Newer comments' ), |
|
3300 |
'screen_reader_text' => __( 'Comments navigation' ), |
|
16 | 3301 |
'aria_label' => __( 'Comments' ), |
3302 |
'class' => 'comment-navigation', |
|
9 | 3303 |
) |
3304 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3305 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3306 |
$prev_link = get_previous_comments_link( $args['prev_text'] ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3307 |
$next_link = get_next_comments_link( $args['next_text'] ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3308 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3309 |
if ( $prev_link ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3310 |
$navigation .= '<div class="nav-previous">' . $prev_link . '</div>'; |
5 | 3311 |
} |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3312 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3313 |
if ( $next_link ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3314 |
$navigation .= '<div class="nav-next">' . $next_link . '</div>'; |
5 | 3315 |
} |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3316 |
|
16 | 3317 |
$navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); |
5 | 3318 |
} |
3319 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3320 |
return $navigation; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3321 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3322 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3323 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3324 |
* Displays navigation to next/previous set of comments, when applicable. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3325 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3326 |
* @since 4.4.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3327 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3328 |
* @param array $args See get_the_comments_navigation() for available arguments. Default empty array. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3329 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3330 |
function the_comments_navigation( $args = array() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3331 |
echo get_the_comments_navigation( $args ); |
0 | 3332 |
} |
3333 |
||
3334 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3335 |
* Retrieves a paginated navigation to next/previous set of comments, when applicable. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3336 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3337 |
* @since 4.4.0 |
16 | 3338 |
* @since 5.3.0 Added the `aria_label` parameter. |
3339 |
* @since 5.5.0 Added the `class` parameter. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3340 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3341 |
* @see paginate_comments_links() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3342 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3343 |
* @param array $args { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3344 |
* Optional. Default pagination arguments. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3345 |
* |
16 | 3346 |
* @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'. |
3347 |
* @type string $aria_label ARIA label text for the nav element. Default 'Comments'. |
|
3348 |
* @type string $class Custom class for the nav element. Default 'comments-pagination'. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3349 |
* } |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3350 |
* @return string Markup for pagination links. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3351 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3352 |
function get_the_comments_pagination( $args = array() ) { |
16 | 3353 |
$navigation = ''; |
3354 |
||
3355 |
// Make sure the nav element has an aria-label attribute: fallback to the screen reader text. |
|
3356 |
if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { |
|
3357 |
$args['aria_label'] = $args['screen_reader_text']; |
|
3358 |
} |
|
3359 |
||
9 | 3360 |
$args = wp_parse_args( |
3361 |
$args, |
|
3362 |
array( |
|
3363 |
'screen_reader_text' => __( 'Comments navigation' ), |
|
16 | 3364 |
'aria_label' => __( 'Comments' ), |
3365 |
'class' => 'comments-pagination', |
|
9 | 3366 |
) |
3367 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3368 |
$args['echo'] = false; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3369 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3370 |
// Make sure we get a string back. Plain is the next best thing. |
16 | 3371 |
if ( isset( $args['type'] ) && 'array' === $args['type'] ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3372 |
$args['type'] = 'plain'; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3373 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3374 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3375 |
$links = paginate_comments_links( $args ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3376 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3377 |
if ( $links ) { |
16 | 3378 |
$navigation = _navigation_markup( $links, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3379 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3380 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3381 |
return $navigation; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3382 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3383 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3384 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3385 |
* Displays a paginated navigation to next/previous set of comments, when applicable. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3386 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3387 |
* @since 4.4.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3388 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3389 |
* @param array $args See get_the_comments_pagination() for available arguments. Default empty array. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3390 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3391 |
function the_comments_pagination( $args = array() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3392 |
echo get_the_comments_pagination( $args ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3393 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3394 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3395 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3396 |
* Retrieves the URL for the current site where the front end is accessible. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3397 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3398 |
* Returns the 'home' option with the appropriate protocol. The protocol will be 'https' |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3399 |
* if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3400 |
* If `$scheme` is 'http' or 'https', is_ssl() is overridden. |
0 | 3401 |
* |
3402 |
* @since 3.0.0 |
|
3403 |
* |
|
16 | 3404 |
* @param string $path Optional. Path relative to the home URL. Default empty. |
3405 |
* @param string|null $scheme Optional. Scheme to give the home URL context. Accepts |
|
3406 |
* 'http', 'https', 'relative', 'rest', or null. Default null. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3407 |
* @return string Home URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3408 |
*/ |
0 | 3409 |
function home_url( $path = '', $scheme = null ) { |
3410 |
return get_home_url( null, $path, $scheme ); |
|
3411 |
} |
|
3412 |
||
3413 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3414 |
* Retrieves the URL for a given site where the front end is accessible. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3415 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3416 |
* Returns the 'home' option with the appropriate protocol. The protocol will be 'https' |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3417 |
* if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3418 |
* If `$scheme` is 'http' or 'https', is_ssl() is overridden. |
0 | 3419 |
* |
3420 |
* @since 3.0.0 |
|
3421 |
* |
|
18 | 3422 |
* @param int|null $blog_id Optional. Site ID. Default null (current site). |
16 | 3423 |
* @param string $path Optional. Path relative to the home URL. Default empty. |
3424 |
* @param string|null $scheme Optional. Scheme to give the home URL context. Accepts |
|
3425 |
* 'http', 'https', 'relative', 'rest', or null. Default null. |
|
5 | 3426 |
* @return string Home URL link with optional path appended. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3427 |
*/ |
0 | 3428 |
function get_home_url( $blog_id = null, $path = '', $scheme = null ) { |
3429 |
$orig_scheme = $scheme; |
|
3430 |
||
9 | 3431 |
if ( empty( $blog_id ) || ! is_multisite() ) { |
0 | 3432 |
$url = get_option( 'home' ); |
3433 |
} else { |
|
3434 |
switch_to_blog( $blog_id ); |
|
3435 |
$url = get_option( 'home' ); |
|
3436 |
restore_current_blog(); |
|
3437 |
} |
|
3438 |
||
16 | 3439 |
if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) { |
18 | 3440 |
if ( is_ssl() ) { |
0 | 3441 |
$scheme = 'https'; |
9 | 3442 |
} else { |
0 | 3443 |
$scheme = parse_url( $url, PHP_URL_SCHEME ); |
9 | 3444 |
} |
0 | 3445 |
} |
3446 |
||
3447 |
$url = set_url_scheme( $url, $scheme ); |
|
3448 |
||
9 | 3449 |
if ( $path && is_string( $path ) ) { |
0 | 3450 |
$url .= '/' . ltrim( $path, '/' ); |
9 | 3451 |
} |
0 | 3452 |
|
5 | 3453 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3454 |
* Filters the home URL. |
5 | 3455 |
* |
3456 |
* @since 3.0.0 |
|
3457 |
* |
|
3458 |
* @param string $url The complete home URL including scheme and path. |
|
3459 |
* @param string $path Path relative to the home URL. Blank string if no path is specified. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3460 |
* @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3461 |
* 'relative', 'rest', or null. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3462 |
* @param int|null $blog_id Site ID, or null for the current site. |
5 | 3463 |
*/ |
0 | 3464 |
return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id ); |
3465 |
} |
|
3466 |
||
3467 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3468 |
* Retrieves the URL for the current site where WordPress application files |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3469 |
* (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. |
0 | 3470 |
* |
3471 |
* Returns the 'site_url' option with the appropriate protocol, 'https' if |
|
3472 |
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is |
|
3473 |
* overridden. |
|
3474 |
* |
|
5 | 3475 |
* @since 3.0.0 |
0 | 3476 |
* |
18 | 3477 |
* @param string $path Optional. Path relative to the site URL. Default empty. |
3478 |
* @param string|null $scheme Optional. Scheme to give the site URL context. See set_url_scheme(). |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3479 |
* @return string Site URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3480 |
*/ |
0 | 3481 |
function site_url( $path = '', $scheme = null ) { |
3482 |
return get_site_url( null, $path, $scheme ); |
|
3483 |
} |
|
3484 |
||
3485 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3486 |
* Retrieves the URL for a given site where WordPress application files |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3487 |
* (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. |
0 | 3488 |
* |
3489 |
* Returns the 'site_url' option with the appropriate protocol, 'https' if |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3490 |
* is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', |
5 | 3491 |
* `is_ssl()` is overridden. |
0 | 3492 |
* |
3493 |
* @since 3.0.0 |
|
3494 |
* |
|
18 | 3495 |
* @param int|null $blog_id Optional. Site ID. Default null (current site). |
3496 |
* @param string $path Optional. Path relative to the site URL. Default empty. |
|
3497 |
* @param string|null $scheme Optional. Scheme to give the site URL context. Accepts |
|
3498 |
* 'http', 'https', 'login', 'login_post', 'admin', or |
|
3499 |
* 'relative'. Default null. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3500 |
* @return string Site URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3501 |
*/ |
0 | 3502 |
function get_site_url( $blog_id = null, $path = '', $scheme = null ) { |
9 | 3503 |
if ( empty( $blog_id ) || ! is_multisite() ) { |
0 | 3504 |
$url = get_option( 'siteurl' ); |
3505 |
} else { |
|
3506 |
switch_to_blog( $blog_id ); |
|
3507 |
$url = get_option( 'siteurl' ); |
|
3508 |
restore_current_blog(); |
|
3509 |
} |
|
3510 |
||
3511 |
$url = set_url_scheme( $url, $scheme ); |
|
3512 |
||
9 | 3513 |
if ( $path && is_string( $path ) ) { |
0 | 3514 |
$url .= '/' . ltrim( $path, '/' ); |
9 | 3515 |
} |
0 | 3516 |
|
5 | 3517 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3518 |
* Filters the site URL. |
5 | 3519 |
* |
3520 |
* @since 2.7.0 |
|
3521 |
* |
|
3522 |
* @param string $url The complete site URL including scheme and path. |
|
3523 |
* @param string $path Path relative to the site URL. Blank string if no path is specified. |
|
3524 |
* @param string|null $scheme Scheme to give the site URL context. Accepts 'http', 'https', 'login', |
|
3525 |
* 'login_post', 'admin', 'relative' or null. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3526 |
* @param int|null $blog_id Site ID, or null for the current site. |
5 | 3527 |
*/ |
0 | 3528 |
return apply_filters( 'site_url', $url, $path, $scheme, $blog_id ); |
3529 |
} |
|
3530 |
||
3531 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3532 |
* Retrieves the URL to the admin area for the current site. |
0 | 3533 |
* |
3534 |
* @since 2.6.0 |
|
3535 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3536 |
* @param string $path Optional. Path relative to the admin URL. Default empty. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3537 |
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3538 |
* 'http' or 'https' can be passed to force those schemes. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3539 |
* @return string Admin URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3540 |
*/ |
0 | 3541 |
function admin_url( $path = '', $scheme = 'admin' ) { |
3542 |
return get_admin_url( null, $path, $scheme ); |
|
3543 |
} |
|
3544 |
||
3545 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3546 |
* Retrieves the URL to the admin area for a given site. |
0 | 3547 |
* |
3548 |
* @since 3.0.0 |
|
3549 |
* |
|
18 | 3550 |
* @param int|null $blog_id Optional. Site ID. Default null (current site). |
3551 |
* @param string $path Optional. Path relative to the admin URL. Default empty. |
|
3552 |
* @param string $scheme Optional. The scheme to use. Accepts 'http' or 'https', |
|
3553 |
* to force those schemes. Default 'admin', which obeys |
|
3554 |
* force_ssl_admin() and is_ssl(). |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3555 |
* @return string Admin URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3556 |
*/ |
0 | 3557 |
function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) { |
9 | 3558 |
$url = get_site_url( $blog_id, 'wp-admin/', $scheme ); |
3559 |
||
3560 |
if ( $path && is_string( $path ) ) { |
|
0 | 3561 |
$url .= ltrim( $path, '/' ); |
9 | 3562 |
} |
0 | 3563 |
|
5 | 3564 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3565 |
* Filters the admin area URL. |
5 | 3566 |
* |
3567 |
* @since 2.8.0 |
|
18 | 3568 |
* @since 5.8.0 The `$scheme` parameter was added. |
5 | 3569 |
* |
18 | 3570 |
* @param string $url The complete admin area URL including scheme and path. |
3571 |
* @param string $path Path relative to the admin area URL. Blank string if no path is specified. |
|
3572 |
* @param int|null $blog_id Site ID, or null for the current site. |
|
3573 |
* @param string|null $scheme The scheme to use. Accepts 'http', 'https', |
|
3574 |
* 'admin', or null. Default 'admin', which obeys force_ssl_admin() and is_ssl(). |
|
5 | 3575 |
*/ |
18 | 3576 |
return apply_filters( 'admin_url', $url, $path, $blog_id, $scheme ); |
0 | 3577 |
} |
3578 |
||
3579 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3580 |
* Retrieves the URL to the includes directory. |
0 | 3581 |
* |
3582 |
* @since 2.6.0 |
|
3583 |
* |
|
18 | 3584 |
* @param string $path Optional. Path relative to the includes URL. Default empty. |
3585 |
* @param string|null $scheme Optional. Scheme to give the includes URL context. Accepts |
|
3586 |
* 'http', 'https', or 'relative'. Default null. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3587 |
* @return string Includes URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3588 |
*/ |
0 | 3589 |
function includes_url( $path = '', $scheme = null ) { |
3590 |
$url = site_url( '/' . WPINC . '/', $scheme ); |
|
3591 |
||
9 | 3592 |
if ( $path && is_string( $path ) ) { |
3593 |
$url .= ltrim( $path, '/' ); |
|
3594 |
} |
|
0 | 3595 |
|
5 | 3596 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3597 |
* Filters the URL to the includes directory. |
5 | 3598 |
* |
3599 |
* @since 2.8.0 |
|
18 | 3600 |
* @since 5.8.0 The `$scheme` parameter was added. |
5 | 3601 |
* |
18 | 3602 |
* @param string $url The complete URL to the includes directory including scheme and path. |
3603 |
* @param string $path Path relative to the URL to the wp-includes directory. Blank string |
|
3604 |
* if no path is specified. |
|
3605 |
* @param string|null $scheme Scheme to give the includes URL context. Accepts |
|
3606 |
* 'http', 'https', 'relative', or null. Default null. |
|
5 | 3607 |
*/ |
18 | 3608 |
return apply_filters( 'includes_url', $url, $path, $scheme ); |
0 | 3609 |
} |
3610 |
||
3611 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3612 |
* Retrieves the URL to the content directory. |
0 | 3613 |
* |
3614 |
* @since 2.6.0 |
|
3615 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3616 |
* @param string $path Optional. Path relative to the content URL. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3617 |
* @return string Content URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3618 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3619 |
function content_url( $path = '' ) { |
0 | 3620 |
$url = set_url_scheme( WP_CONTENT_URL ); |
3621 |
||
9 | 3622 |
if ( $path && is_string( $path ) ) { |
3623 |
$url .= '/' . ltrim( $path, '/' ); |
|
3624 |
} |
|
0 | 3625 |
|
5 | 3626 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3627 |
* Filters the URL to the content directory. |
5 | 3628 |
* |
3629 |
* @since 2.8.0 |
|
3630 |
* |
|
3631 |
* @param string $url The complete URL to the content directory including scheme and path. |
|
3632 |
* @param string $path Path relative to the URL to the content directory. Blank string |
|
3633 |
* if no path is specified. |
|
3634 |
*/ |
|
9 | 3635 |
return apply_filters( 'content_url', $url, $path ); |
0 | 3636 |
} |
3637 |
||
3638 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3639 |
* Retrieves a URL within the plugins or mu-plugins directory. |
0 | 3640 |
* |
5 | 3641 |
* Defaults to the plugins directory URL if no arguments are supplied. |
3642 |
* |
|
0 | 3643 |
* @since 2.6.0 |
3644 |
* |
|
16 | 3645 |
* @param string $path Optional. Extra path appended to the end of the URL, including |
3646 |
* the relative directory if $plugin is supplied. Default empty. |
|
3647 |
* @param string $plugin Optional. A full path to a file inside a plugin or mu-plugin. |
|
3648 |
* The URL will be relative to its directory. Default empty. |
|
3649 |
* Typically this is done by passing `__FILE__` as the argument. |
|
5 | 3650 |
* @return string Plugins URL link with optional paths appended. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3651 |
*/ |
5 | 3652 |
function plugins_url( $path = '', $plugin = '' ) { |
3653 |
||
9 | 3654 |
$path = wp_normalize_path( $path ); |
3655 |
$plugin = wp_normalize_path( $plugin ); |
|
5 | 3656 |
$mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR ); |
0 | 3657 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3658 |
if ( ! empty( $plugin ) && str_starts_with( $plugin, $mu_plugin_dir ) ) { |
0 | 3659 |
$url = WPMU_PLUGIN_URL; |
9 | 3660 |
} else { |
0 | 3661 |
$url = WP_PLUGIN_URL; |
9 | 3662 |
} |
0 | 3663 |
|
3664 |
$url = set_url_scheme( $url ); |
|
3665 |
||
9 | 3666 |
if ( ! empty( $plugin ) && is_string( $plugin ) ) { |
3667 |
$folder = dirname( plugin_basename( $plugin ) ); |
|
16 | 3668 |
if ( '.' !== $folder ) { |
9 | 3669 |
$url .= '/' . ltrim( $folder, '/' ); |
3670 |
} |
|
0 | 3671 |
} |
3672 |
||
9 | 3673 |
if ( $path && is_string( $path ) ) { |
3674 |
$url .= '/' . ltrim( $path, '/' ); |
|
3675 |
} |
|
0 | 3676 |
|
5 | 3677 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3678 |
* Filters the URL to the plugins directory. |
5 | 3679 |
* |
3680 |
* @since 2.8.0 |
|
3681 |
* |
|
3682 |
* @param string $url The complete URL to the plugins directory including scheme and path. |
|
3683 |
* @param string $path Path relative to the URL to the plugins directory. Blank string |
|
3684 |
* if no path is specified. |
|
3685 |
* @param string $plugin The plugin file path to be relative to. Blank string if no plugin |
|
3686 |
* is specified. |
|
3687 |
*/ |
|
3688 |
return apply_filters( 'plugins_url', $url, $path, $plugin ); |
|
0 | 3689 |
} |
3690 |
||
3691 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3692 |
* Retrieves the site URL for the current network. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3693 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3694 |
* Returns the site URL with the appropriate protocol, 'https' if |
0 | 3695 |
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is |
3696 |
* overridden. |
|
3697 |
* |
|
3698 |
* @since 3.0.0 |
|
3699 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3700 |
* @see set_url_scheme() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3701 |
* |
18 | 3702 |
* @param string $path Optional. Path relative to the site URL. Default empty. |
3703 |
* @param string|null $scheme Optional. Scheme to give the site URL context. Accepts |
|
3704 |
* 'http', 'https', or 'relative'. Default null. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3705 |
* @return string Site URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3706 |
*/ |
0 | 3707 |
function network_site_url( $path = '', $scheme = null ) { |
9 | 3708 |
if ( ! is_multisite() ) { |
3709 |
return site_url( $path, $scheme ); |
|
3710 |
} |
|
0 | 3711 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3712 |
$current_network = get_network(); |
5 | 3713 |
|
16 | 3714 |
if ( 'relative' === $scheme ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3715 |
$url = $current_network->path; |
9 | 3716 |
} else { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3717 |
$url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme ); |
9 | 3718 |
} |
3719 |
||
3720 |
if ( $path && is_string( $path ) ) { |
|
0 | 3721 |
$url .= ltrim( $path, '/' ); |
9 | 3722 |
} |
0 | 3723 |
|
5 | 3724 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3725 |
* Filters the network site URL. |
5 | 3726 |
* |
3727 |
* @since 3.0.0 |
|
3728 |
* |
|
3729 |
* @param string $url The complete network site URL including scheme and path. |
|
3730 |
* @param string $path Path relative to the network site URL. Blank string if |
|
3731 |
* no path is specified. |
|
3732 |
* @param string|null $scheme Scheme to give the URL context. Accepts 'http', 'https', |
|
3733 |
* 'relative' or null. |
|
3734 |
*/ |
|
0 | 3735 |
return apply_filters( 'network_site_url', $url, $path, $scheme ); |
3736 |
} |
|
3737 |
||
3738 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3739 |
* Retrieves the home URL for the current network. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3740 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3741 |
* Returns the home URL with the appropriate protocol, 'https' is_ssl() |
5 | 3742 |
* and 'http' otherwise. If `$scheme` is 'http' or 'https', `is_ssl()` is |
0 | 3743 |
* overridden. |
3744 |
* |
|
3745 |
* @since 3.0.0 |
|
3746 |
* |
|
18 | 3747 |
* @param string $path Optional. Path relative to the home URL. Default empty. |
3748 |
* @param string|null $scheme Optional. Scheme to give the home URL context. Accepts |
|
3749 |
* 'http', 'https', or 'relative'. Default null. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3750 |
* @return string Home URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3751 |
*/ |
0 | 3752 |
function network_home_url( $path = '', $scheme = null ) { |
9 | 3753 |
if ( ! is_multisite() ) { |
3754 |
return home_url( $path, $scheme ); |
|
3755 |
} |
|
0 | 3756 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3757 |
$current_network = get_network(); |
9 | 3758 |
$orig_scheme = $scheme; |
3759 |
||
16 | 3760 |
if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) { |
18 | 3761 |
$scheme = is_ssl() ? 'https' : 'http'; |
9 | 3762 |
} |
3763 |
||
16 | 3764 |
if ( 'relative' === $scheme ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3765 |
$url = $current_network->path; |
9 | 3766 |
} else { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3767 |
$url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme ); |
9 | 3768 |
} |
3769 |
||
3770 |
if ( $path && is_string( $path ) ) { |
|
0 | 3771 |
$url .= ltrim( $path, '/' ); |
9 | 3772 |
} |
0 | 3773 |
|
5 | 3774 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3775 |
* Filters the network home URL. |
5 | 3776 |
* |
3777 |
* @since 3.0.0 |
|
3778 |
* |
|
3779 |
* @param string $url The complete network home URL including scheme and path. |
|
3780 |
* @param string $path Path relative to the network home URL. Blank string |
|
3781 |
* if no path is specified. |
|
3782 |
* @param string|null $orig_scheme Scheme to give the URL context. Accepts 'http', 'https', |
|
3783 |
* 'relative' or null. |
|
3784 |
*/ |
|
9 | 3785 |
return apply_filters( 'network_home_url', $url, $path, $orig_scheme ); |
0 | 3786 |
} |
3787 |
||
3788 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3789 |
* Retrieves the URL to the admin area for the network. |
0 | 3790 |
* |
3791 |
* @since 3.0.0 |
|
3792 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3793 |
* @param string $path Optional path relative to the admin URL. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3794 |
* @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3795 |
* and is_ssl(). 'http' or 'https' can be passed to force those schemes. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3796 |
* @return string Admin URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3797 |
*/ |
0 | 3798 |
function network_admin_url( $path = '', $scheme = 'admin' ) { |
9 | 3799 |
if ( ! is_multisite() ) { |
0 | 3800 |
return admin_url( $path, $scheme ); |
9 | 3801 |
} |
3802 |
||
3803 |
$url = network_site_url( 'wp-admin/network/', $scheme ); |
|
3804 |
||
3805 |
if ( $path && is_string( $path ) ) { |
|
3806 |
$url .= ltrim( $path, '/' ); |
|
3807 |
} |
|
0 | 3808 |
|
5 | 3809 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3810 |
* Filters the network admin URL. |
5 | 3811 |
* |
3812 |
* @since 3.0.0 |
|
18 | 3813 |
* @since 5.8.0 The `$scheme` parameter was added. |
5 | 3814 |
* |
18 | 3815 |
* @param string $url The complete network admin URL including scheme and path. |
3816 |
* @param string $path Path relative to the network admin URL. Blank string if |
|
3817 |
* no path is specified. |
|
3818 |
* @param string|null $scheme The scheme to use. Accepts 'http', 'https', |
|
3819 |
* 'admin', or null. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). |
|
5 | 3820 |
*/ |
18 | 3821 |
return apply_filters( 'network_admin_url', $url, $path, $scheme ); |
0 | 3822 |
} |
3823 |
||
3824 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3825 |
* Retrieves the URL to the admin area for the current user. |
0 | 3826 |
* |
3827 |
* @since 3.0.0 |
|
3828 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3829 |
* @param string $path Optional. Path relative to the admin URL. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3830 |
* @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3831 |
* and is_ssl(). 'http' or 'https' can be passed to force those schemes. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3832 |
* @return string Admin URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3833 |
*/ |
0 | 3834 |
function user_admin_url( $path = '', $scheme = 'admin' ) { |
9 | 3835 |
$url = network_site_url( 'wp-admin/user/', $scheme ); |
3836 |
||
3837 |
if ( $path && is_string( $path ) ) { |
|
3838 |
$url .= ltrim( $path, '/' ); |
|
3839 |
} |
|
0 | 3840 |
|
5 | 3841 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3842 |
* Filters the user admin URL for the current user. |
5 | 3843 |
* |
3844 |
* @since 3.1.0 |
|
18 | 3845 |
* @since 5.8.0 The `$scheme` parameter was added. |
5 | 3846 |
* |
18 | 3847 |
* @param string $url The complete URL including scheme and path. |
3848 |
* @param string $path Path relative to the URL. Blank string if |
|
3849 |
* no path is specified. |
|
3850 |
* @param string|null $scheme The scheme to use. Accepts 'http', 'https', |
|
3851 |
* 'admin', or null. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). |
|
5 | 3852 |
*/ |
18 | 3853 |
return apply_filters( 'user_admin_url', $url, $path, $scheme ); |
0 | 3854 |
} |
3855 |
||
3856 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3857 |
* Retrieves the URL to the admin area for either the current site or the network depending on context. |
0 | 3858 |
* |
3859 |
* @since 3.1.0 |
|
3860 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3861 |
* @param string $path Optional. Path relative to the admin URL. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3862 |
* @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3863 |
* and is_ssl(). 'http' or 'https' can be passed to force those schemes. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3864 |
* @return string Admin URL link with optional path appended. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3865 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3866 |
function self_admin_url( $path = '', $scheme = 'admin' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3867 |
if ( is_network_admin() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3868 |
$url = network_admin_url( $path, $scheme ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3869 |
} elseif ( is_user_admin() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3870 |
$url = user_admin_url( $path, $scheme ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3871 |
} else { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3872 |
$url = admin_url( $path, $scheme ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3873 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3874 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3875 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3876 |
* Filters the admin URL for the current site or network depending on context. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3877 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3878 |
* @since 4.9.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3879 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3880 |
* @param string $url The complete URL including scheme and path. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3881 |
* @param string $path Path relative to the URL. Blank string if no path is specified. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3882 |
* @param string $scheme The scheme to use. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3883 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3884 |
return apply_filters( 'self_admin_url', $url, $path, $scheme ); |
0 | 3885 |
} |
3886 |
||
3887 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3888 |
* Sets the scheme for a URL. |
0 | 3889 |
* |
3890 |
* @since 3.4.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3891 |
* @since 4.4.0 The 'rest' scheme was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3892 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3893 |
* @param string $url Absolute URL that includes a scheme |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3894 |
* @param string|null $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3895 |
* 'login_post', 'admin', 'relative', 'rest', 'rpc', or null. Default null. |
16 | 3896 |
* @return string URL with chosen scheme. |
0 | 3897 |
*/ |
3898 |
function set_url_scheme( $url, $scheme = null ) { |
|
3899 |
$orig_scheme = $scheme; |
|
5 | 3900 |
|
3901 |
if ( ! $scheme ) { |
|
3902 |
$scheme = is_ssl() ? 'https' : 'http'; |
|
16 | 3903 |
} elseif ( 'admin' === $scheme || 'login' === $scheme || 'login_post' === $scheme || 'rpc' === $scheme ) { |
5 | 3904 |
$scheme = is_ssl() || force_ssl_admin() ? 'https' : 'http'; |
16 | 3905 |
} elseif ( 'http' !== $scheme && 'https' !== $scheme && 'relative' !== $scheme ) { |
5 | 3906 |
$scheme = is_ssl() ? 'https' : 'http'; |
0 | 3907 |
} |
3908 |
||
3909 |
$url = trim( $url ); |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
3910 |
if ( str_starts_with( $url, '//' ) ) { |
0 | 3911 |
$url = 'http:' . $url; |
9 | 3912 |
} |
0 | 3913 |
|
16 | 3914 |
if ( 'relative' === $scheme ) { |
0 | 3915 |
$url = ltrim( preg_replace( '#^\w+://[^/]*#', '', $url ) ); |
16 | 3916 |
if ( '' !== $url && '/' === $url[0] ) { |
9 | 3917 |
$url = '/' . ltrim( $url, "/ \t\n\r\0\x0B" ); |
3918 |
} |
|
0 | 3919 |
} else { |
3920 |
$url = preg_replace( '#^\w+://#', $scheme . '://', $url ); |
|
3921 |
} |
|
3922 |
||
5 | 3923 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3924 |
* Filters the resulting URL after setting the scheme. |
5 | 3925 |
* |
3926 |
* @since 3.4.0 |
|
3927 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3928 |
* @param string $url The complete URL including scheme and path. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3929 |
* @param string $scheme Scheme applied to the URL. One of 'http', 'https', or 'relative'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3930 |
* @param string|null $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3931 |
* 'login_post', 'admin', 'relative', 'rest', 'rpc', or null. |
5 | 3932 |
*/ |
0 | 3933 |
return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme ); |
3934 |
} |
|
3935 |
||
3936 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3937 |
* Retrieves the URL to the user's dashboard. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3938 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3939 |
* If a user does not belong to any site, the global user dashboard is used. If the user |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3940 |
* belongs to the current site, the dashboard for the current site is returned. If the user |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3941 |
* cannot edit the current site, the dashboard to the user's primary site is returned. |
0 | 3942 |
* |
3943 |
* @since 3.1.0 |
|
3944 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3945 |
* @param int $user_id Optional. User ID. Defaults to current user. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3946 |
* @param string $path Optional path relative to the dashboard. Use only paths known to |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3947 |
* both site and user admins. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3948 |
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3949 |
* and is_ssl(). 'http' or 'https' can be passed to force those schemes. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3950 |
* @return string Dashboard URL link with optional path appended. |
0 | 3951 |
*/ |
5 | 3952 |
function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) { |
3953 |
$user_id = $user_id ? (int) $user_id : get_current_user_id(); |
|
0 | 3954 |
|
3955 |
$blogs = get_blogs_of_user( $user_id ); |
|
16 | 3956 |
|
9 | 3957 |
if ( is_multisite() && ! user_can( $user_id, 'manage_network' ) && empty( $blogs ) ) { |
0 | 3958 |
$url = user_admin_url( $path, $scheme ); |
3959 |
} elseif ( ! is_multisite() ) { |
|
3960 |
$url = admin_url( $path, $scheme ); |
|
3961 |
} else { |
|
3962 |
$current_blog = get_current_blog_id(); |
|
16 | 3963 |
|
3964 |
if ( $current_blog && ( user_can( $user_id, 'manage_network' ) || in_array( $current_blog, array_keys( $blogs ), true ) ) ) { |
|
0 | 3965 |
$url = admin_url( $path, $scheme ); |
3966 |
} else { |
|
3967 |
$active = get_active_blog_for_user( $user_id ); |
|
9 | 3968 |
if ( $active ) { |
0 | 3969 |
$url = get_admin_url( $active->blog_id, $path, $scheme ); |
9 | 3970 |
} else { |
0 | 3971 |
$url = user_admin_url( $path, $scheme ); |
9 | 3972 |
} |
0 | 3973 |
} |
3974 |
} |
|
3975 |
||
5 | 3976 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3977 |
* Filters the dashboard URL for a user. |
5 | 3978 |
* |
3979 |
* @since 3.1.0 |
|
3980 |
* |
|
3981 |
* @param string $url The complete URL including scheme and path. |
|
3982 |
* @param int $user_id The user ID. |
|
3983 |
* @param string $path Path relative to the URL. Blank string if no path is specified. |
|
3984 |
* @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login', |
|
3985 |
* 'login_post', 'admin', 'relative' or null. |
|
3986 |
*/ |
|
9 | 3987 |
return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme ); |
0 | 3988 |
} |
3989 |
||
3990 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3991 |
* Retrieves the URL to the user's profile editor. |
0 | 3992 |
* |
3993 |
* @since 3.1.0 |
|
3994 |
* |
|
5 | 3995 |
* @param int $user_id Optional. User ID. Defaults to current user. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3996 |
* @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3997 |
* and is_ssl(). 'http' or 'https' can be passed to force those schemes. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3998 |
* @return string Dashboard URL link with optional path appended. |
0 | 3999 |
*/ |
5 | 4000 |
function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) { |
4001 |
$user_id = $user_id ? (int) $user_id : get_current_user_id(); |
|
0 | 4002 |
|
9 | 4003 |
if ( is_user_admin() ) { |
0 | 4004 |
$url = user_admin_url( 'profile.php', $scheme ); |
9 | 4005 |
} elseif ( is_network_admin() ) { |
0 | 4006 |
$url = network_admin_url( 'profile.php', $scheme ); |
9 | 4007 |
} else { |
5 | 4008 |
$url = get_dashboard_url( $user_id, 'profile.php', $scheme ); |
9 | 4009 |
} |
5 | 4010 |
|
4011 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4012 |
* Filters the URL for a user's profile editor. |
5 | 4013 |
* |
4014 |
* @since 3.1.0 |
|
4015 |
* |
|
4016 |
* @param string $url The complete URL including scheme and path. |
|
4017 |
* @param int $user_id The user ID. |
|
4018 |
* @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login', |
|
4019 |
* 'login_post', 'admin', 'relative' or null. |
|
4020 |
*/ |
|
9 | 4021 |
return apply_filters( 'edit_profile_url', $url, $user_id, $scheme ); |
0 | 4022 |
} |
4023 |
||
4024 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4025 |
* Returns the canonical URL for a post. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4026 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4027 |
* When the post is the same as the current requested page the function will handle the |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4028 |
* pagination arguments too. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4029 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4030 |
* @since 4.6.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4031 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4032 |
* @param int|WP_Post $post Optional. Post ID or object. Default is global `$post`. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4033 |
* @return string|false The canonical URL. False if the post does not exist |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4034 |
* or has not been published yet. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4035 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4036 |
function wp_get_canonical_url( $post = null ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4037 |
$post = get_post( $post ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4038 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4039 |
if ( ! $post ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4040 |
return false; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4041 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4042 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4043 |
if ( 'publish' !== $post->post_status ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4044 |
return false; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4045 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4046 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4047 |
$canonical_url = get_permalink( $post ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4048 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4049 |
// If a canonical is being generated for the current page, make sure it has pagination if needed. |
16 | 4050 |
if ( get_queried_object_id() === $post->ID ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4051 |
$page = get_query_var( 'page', 0 ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4052 |
if ( $page >= 2 ) { |
16 | 4053 |
if ( ! get_option( 'permalink_structure' ) ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4054 |
$canonical_url = add_query_arg( 'page', $page, $canonical_url ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4055 |
} else { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4056 |
$canonical_url = trailingslashit( $canonical_url ) . user_trailingslashit( $page, 'single_paged' ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4057 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4058 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4059 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4060 |
$cpage = get_query_var( 'cpage', 0 ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4061 |
if ( $cpage ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4062 |
$canonical_url = get_comments_pagenum_link( $cpage ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4063 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4064 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4065 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4066 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4067 |
* Filters the canonical URL for a post. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4068 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4069 |
* @since 4.6.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4070 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4071 |
* @param string $canonical_url The post's canonical URL. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4072 |
* @param WP_Post $post Post object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4073 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4074 |
return apply_filters( 'get_canonical_url', $canonical_url, $post ); |
0 | 4075 |
} |
4076 |
||
4077 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4078 |
* Outputs rel=canonical for singular queries. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4079 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4080 |
* @since 2.9.0 |
9 | 4081 |
* @since 4.6.0 Adjusted to use `wp_get_canonical_url()`. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4082 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4083 |
function rel_canonical() { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4084 |
if ( ! is_singular() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4085 |
return; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4086 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4087 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4088 |
$id = get_queried_object_id(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4089 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4090 |
if ( 0 === $id ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4091 |
return; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4092 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4093 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4094 |
$url = wp_get_canonical_url( $id ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4095 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4096 |
if ( ! empty( $url ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4097 |
echo '<link rel="canonical" href="' . esc_url( $url ) . '" />' . "\n"; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4098 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4099 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4100 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4101 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4102 |
* Returns a shortlink for a post, page, attachment, or site. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4103 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4104 |
* This function exists to provide a shortlink tag that all themes and plugins can target. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4105 |
* A plugin must hook in to provide the actual shortlinks. Default shortlink support is |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4106 |
* limited to providing ?p= style links for posts. Plugins can short-circuit this function |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4107 |
* via the {@see 'pre_get_shortlink'} filter or filter the output via the {@see 'get_shortlink'} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4108 |
* filter. |
0 | 4109 |
* |
9 | 4110 |
* @since 3.0.0 |
0 | 4111 |
* |
16 | 4112 |
* @param int $id Optional. A post or site ID. Default is 0, which means the current post or site. |
19 | 4113 |
* @param string $context Optional. Whether the ID is a 'site' ID, 'post' ID, or 'media' ID. If 'post', |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4114 |
* the post_type of the post is consulted. If 'query', the current query is consulted |
16 | 4115 |
* to determine the ID and context. Default 'post'. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4116 |
* @param bool $allow_slugs Optional. Whether to allow post slugs in the shortlink. It is up to the plugin how |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4117 |
* and whether to honor this. Default true. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4118 |
* @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4119 |
* are not enabled. |
0 | 4120 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4121 |
function wp_get_shortlink( $id = 0, $context = 'post', $allow_slugs = true ) { |
5 | 4122 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4123 |
* Filters whether to preempt generating a shortlink for the given post. |
5 | 4124 |
* |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4125 |
* Returning a value other than false from the filter will short-circuit |
16 | 4126 |
* the shortlink generation process, returning that value instead. |
5 | 4127 |
* |
4128 |
* @since 3.0.0 |
|
4129 |
* |
|
16 | 4130 |
* @param false|string $return Short-circuit return value. Either false or a URL string. |
4131 |
* @param int $id Post ID, or 0 for the current post. |
|
4132 |
* @param string $context The context for the link. One of 'post' or 'query', |
|
4133 |
* @param bool $allow_slugs Whether to allow post slugs in the shortlink. |
|
5 | 4134 |
*/ |
4135 |
$shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs ); |
|
4136 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4137 |
if ( false !== $shortlink ) { |
0 | 4138 |
return $shortlink; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4139 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4140 |
|
0 | 4141 |
$post_id = 0; |
16 | 4142 |
if ( 'query' === $context && is_singular() ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4143 |
$post_id = get_queried_object_id(); |
9 | 4144 |
$post = get_post( $post_id ); |
16 | 4145 |
} elseif ( 'post' === $context ) { |
0 | 4146 |
$post = get_post( $id ); |
9 | 4147 |
if ( ! empty( $post->ID ) ) { |
0 | 4148 |
$post_id = $post->ID; |
9 | 4149 |
} |
0 | 4150 |
} |
4151 |
||
4152 |
$shortlink = ''; |
|
4153 |
||
16 | 4154 |
// Return `?p=` link for all public post types. |
0 | 4155 |
if ( ! empty( $post_id ) ) { |
4156 |
$post_type = get_post_type_object( $post->post_type ); |
|
5 | 4157 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4158 |
if ( 'page' === $post->post_type |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4159 |
&& 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post->ID |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4160 |
) { |
5 | 4161 |
$shortlink = home_url( '/' ); |
18 | 4162 |
} elseif ( $post_type && $post_type->public ) { |
5 | 4163 |
$shortlink = home_url( '?p=' . $post_id ); |
4164 |
} |
|
0 | 4165 |
} |
4166 |
||
5 | 4167 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4168 |
* Filters the shortlink for a post. |
5 | 4169 |
* |
4170 |
* @since 3.0.0 |
|
4171 |
* |
|
4172 |
* @param string $shortlink Shortlink URL. |
|
4173 |
* @param int $id Post ID, or 0 for the current post. |
|
4174 |
* @param string $context The context for the link. One of 'post' or 'query', |
|
4175 |
* @param bool $allow_slugs Whether to allow post slugs in the shortlink. Not used by default. |
|
4176 |
*/ |
|
4177 |
return apply_filters( 'get_shortlink', $shortlink, $id, $context, $allow_slugs ); |
|
0 | 4178 |
} |
4179 |
||
4180 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4181 |
* Injects rel=shortlink into the head if a shortlink is defined for the current page. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4182 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4183 |
* Attached to the {@see 'wp_head'} action. |
0 | 4184 |
* |
4185 |
* @since 3.0.0 |
|
4186 |
*/ |
|
4187 |
function wp_shortlink_wp_head() { |
|
4188 |
$shortlink = wp_get_shortlink( 0, 'query' ); |
|
4189 |
||
9 | 4190 |
if ( empty( $shortlink ) ) { |
0 | 4191 |
return; |
9 | 4192 |
} |
0 | 4193 |
|
4194 |
echo "<link rel='shortlink' href='" . esc_url( $shortlink ) . "' />\n"; |
|
4195 |
} |
|
4196 |
||
4197 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4198 |
* Sends a Link: rel=shortlink header if a shortlink is defined for the current page. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4199 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4200 |
* Attached to the {@see 'wp'} action. |
0 | 4201 |
* |
4202 |
* @since 3.0.0 |
|
4203 |
*/ |
|
4204 |
function wp_shortlink_header() { |
|
9 | 4205 |
if ( headers_sent() ) { |
0 | 4206 |
return; |
9 | 4207 |
} |
4208 |
||
4209 |
$shortlink = wp_get_shortlink( 0, 'query' ); |
|
4210 |
||
4211 |
if ( empty( $shortlink ) ) { |
|
0 | 4212 |
return; |
9 | 4213 |
} |
4214 |
||
4215 |
header( 'Link: <' . $shortlink . '>; rel=shortlink', false ); |
|
0 | 4216 |
} |
4217 |
||
4218 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4219 |
* Displays the shortlink for a post. |
0 | 4220 |
* |
4221 |
* Must be called from inside "The Loop" |
|
4222 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4223 |
* Call like the_shortlink( __( 'Shortlinkage FTW' ) ) |
0 | 4224 |
* |
4225 |
* @since 3.0.0 |
|
4226 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4227 |
* @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.' |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4228 |
* @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4229 |
* @param string $before Optional HTML to display before the link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4230 |
* @param string $after Optional HTML to display after the link. Default empty. |
0 | 4231 |
*/ |
4232 |
function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) { |
|
4233 |
$post = get_post(); |
|
4234 |
||
9 | 4235 |
if ( empty( $text ) ) { |
4236 |
$text = __( 'This is the short link.' ); |
|
4237 |
} |
|
4238 |
||
4239 |
if ( empty( $title ) ) { |
|
0 | 4240 |
$title = the_title_attribute( array( 'echo' => false ) ); |
9 | 4241 |
} |
0 | 4242 |
|
4243 |
$shortlink = wp_get_shortlink( $post->ID ); |
|
4244 |
||
9 | 4245 |
if ( ! empty( $shortlink ) ) { |
0 | 4246 |
$link = '<a rel="shortlink" href="' . esc_url( $shortlink ) . '" title="' . $title . '">' . $text . '</a>'; |
5 | 4247 |
|
4248 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4249 |
* Filters the short link anchor tag for a post. |
5 | 4250 |
* |
4251 |
* @since 3.0.0 |
|
4252 |
* |
|
4253 |
* @param string $link Shortlink anchor tag. |
|
4254 |
* @param string $shortlink Shortlink URL. |
|
4255 |
* @param string $text Shortlink's text. |
|
4256 |
* @param string $title Shortlink's title attribute. |
|
4257 |
*/ |
|
0 | 4258 |
$link = apply_filters( 'the_shortlink', $link, $shortlink, $text, $title ); |
4259 |
echo $before, $link, $after; |
|
4260 |
} |
|
4261 |
} |
|
5 | 4262 |
|
4263 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4264 |
* Retrieves the avatar URL. |
5 | 4265 |
* |
4266 |
* @since 4.2.0 |
|
4267 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4268 |
* @param mixed $id_or_email The avatar to retrieve a URL for. Accepts a user ID, Gravatar MD5 hash, |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4269 |
* user email, WP_User object, WP_Post object, or WP_Comment object. |
5 | 4270 |
* @param array $args { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4271 |
* Optional. Arguments to use instead of the default arguments. |
5 | 4272 |
* |
4273 |
* @type int $size Height and width of the avatar in pixels. Default 96. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4274 |
* @type string $default URL for the default image or a default type. Accepts: |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4275 |
* - '404' (return a 404 instead of a default image) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4276 |
* - 'retro' (a 8-bit arcade-style pixelated face) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4277 |
* - 'robohash' (a robot) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4278 |
* - 'monsterid' (a monster) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4279 |
* - 'wavatar' (a cartoon face) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4280 |
* - 'identicon' (the "quilt", a geometric pattern) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4281 |
* - 'mystery', 'mm', or 'mysteryman' (The Oyster Man) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4282 |
* - 'blank' (transparent GIF) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4283 |
* - 'gravatar_default' (the Gravatar logo) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4284 |
* Default is the value of the 'avatar_default' option, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4285 |
* with a fallback of 'mystery'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4286 |
* @type bool $force_default Whether to always show the default image, never the Gravatar. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4287 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4288 |
* @type string $rating What rating to display avatars up to. Accepts: |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4289 |
* - 'G' (suitable for all audiences) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4290 |
* - 'PG' (possibly offensive, usually for audiences 13 and above) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4291 |
* - 'R' (intended for adult audiences above 17) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4292 |
* - 'X' (even more mature than above) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4293 |
* Default is the value of the 'avatar_rating' option. |
5 | 4294 |
* @type string $scheme URL scheme to use. See set_url_scheme() for accepted values. |
4295 |
* Default null. |
|
4296 |
* @type array $processed_args When the function returns, the value will be the processed/sanitized $args |
|
4297 |
* plus a "found_avatar" guess. Pass as a reference. Default null. |
|
4298 |
* } |
|
16 | 4299 |
* @return string|false The URL of the avatar on success, false on failure. |
5 | 4300 |
*/ |
4301 |
function get_avatar_url( $id_or_email, $args = null ) { |
|
4302 |
$args = get_avatar_data( $id_or_email, $args ); |
|
4303 |
return $args['url']; |
|
4304 |
} |
|
4305 |
||
9 | 4306 |
/** |
4307 |
* Check if this comment type allows avatars to be retrieved. |
|
4308 |
* |
|
4309 |
* @since 5.1.0 |
|
4310 |
* |
|
4311 |
* @param string $comment_type Comment type to check. |
|
4312 |
* @return bool Whether the comment type is allowed for retrieving avatars. |
|
4313 |
*/ |
|
4314 |
function is_avatar_comment_type( $comment_type ) { |
|
4315 |
/** |
|
4316 |
* Filters the list of allowed comment types for retrieving avatars. |
|
4317 |
* |
|
4318 |
* @since 3.0.0 |
|
4319 |
* |
|
4320 |
* @param array $types An array of content types. Default only contains 'comment'. |
|
4321 |
*/ |
|
4322 |
$allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) ); |
|
4323 |
||
4324 |
return in_array( $comment_type, (array) $allowed_comment_types, true ); |
|
4325 |
} |
|
4326 |
||
5 | 4327 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4328 |
* Retrieves default data about the avatar. |
5 | 4329 |
* |
4330 |
* @since 4.2.0 |
|
4331 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4332 |
* @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, |
16 | 4333 |
* user email, WP_User object, WP_Post object, or WP_Comment object. |
5 | 4334 |
* @param array $args { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4335 |
* Optional. Arguments to use instead of the default arguments. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4336 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4337 |
* @type int $size Height and width of the avatar in pixels. Default 96. |
5 | 4338 |
* @type int $height Display height of the avatar in pixels. Defaults to $size. |
4339 |
* @type int $width Display width of the avatar in pixels. Defaults to $size. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4340 |
* @type string $default URL for the default image or a default type. Accepts: |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4341 |
* - '404' (return a 404 instead of a default image) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4342 |
* - 'retro' (a 8-bit arcade-style pixelated face) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4343 |
* - 'robohash' (a robot) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4344 |
* - 'monsterid' (a monster) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4345 |
* - 'wavatar' (a cartoon face) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4346 |
* - 'identicon' (the "quilt", a geometric pattern) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4347 |
* - 'mystery', 'mm', or 'mysteryman' (The Oyster Man) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4348 |
* - 'blank' (transparent GIF) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4349 |
* - 'gravatar_default' (the Gravatar logo) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4350 |
* Default is the value of the 'avatar_default' option, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4351 |
* with a fallback of 'mystery'. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4352 |
* @type bool $force_default Whether to always show the default image, never the Gravatar. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4353 |
* Default false. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4354 |
* @type string $rating What rating to display avatars up to. Accepts: |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4355 |
* - 'G' (suitable for all audiences) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4356 |
* - 'PG' (possibly offensive, usually for audiences 13 and above) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4357 |
* - 'R' (intended for adult audiences above 17) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4358 |
* - 'X' (even more mature than above) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4359 |
* Default is the value of the 'avatar_rating' option. |
5 | 4360 |
* @type string $scheme URL scheme to use. See set_url_scheme() for accepted values. |
4361 |
* Default null. |
|
4362 |
* @type array $processed_args When the function returns, the value will be the processed/sanitized $args |
|
4363 |
* plus a "found_avatar" guess. Pass as a reference. Default null. |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4364 |
* @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4365 |
* Default empty. |
5 | 4366 |
* } |
16 | 4367 |
* @return array { |
5 | 4368 |
* Along with the arguments passed in `$args`, this will contain a couple of extra arguments. |
4369 |
* |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4370 |
* @type bool $found_avatar True if an avatar was found for this user, |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4371 |
* false or not set if none was found. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4372 |
* @type string|false $url The URL of the avatar that was found, or false. |
5 | 4373 |
* } |
4374 |
*/ |
|
4375 |
function get_avatar_data( $id_or_email, $args = null ) { |
|
9 | 4376 |
$args = wp_parse_args( |
4377 |
$args, |
|
4378 |
array( |
|
4379 |
'size' => 96, |
|
4380 |
'height' => null, |
|
4381 |
'width' => null, |
|
4382 |
'default' => get_option( 'avatar_default', 'mystery' ), |
|
4383 |
'force_default' => false, |
|
4384 |
'rating' => get_option( 'avatar_rating' ), |
|
4385 |
'scheme' => null, |
|
16 | 4386 |
'processed_args' => null, // If used, should be a reference. |
9 | 4387 |
'extra_attr' => '', |
4388 |
) |
|
4389 |
); |
|
5 | 4390 |
|
4391 |
if ( is_numeric( $args['size'] ) ) { |
|
4392 |
$args['size'] = absint( $args['size'] ); |
|
4393 |
if ( ! $args['size'] ) { |
|
4394 |
$args['size'] = 96; |
|
4395 |
} |
|
4396 |
} else { |
|
4397 |
$args['size'] = 96; |
|
4398 |
} |
|
4399 |
||
4400 |
if ( is_numeric( $args['height'] ) ) { |
|
4401 |
$args['height'] = absint( $args['height'] ); |
|
4402 |
if ( ! $args['height'] ) { |
|
4403 |
$args['height'] = $args['size']; |
|
4404 |
} |
|
4405 |
} else { |
|
4406 |
$args['height'] = $args['size']; |
|
4407 |
} |
|
4408 |
||
4409 |
if ( is_numeric( $args['width'] ) ) { |
|
4410 |
$args['width'] = absint( $args['width'] ); |
|
4411 |
if ( ! $args['width'] ) { |
|
4412 |
$args['width'] = $args['size']; |
|
4413 |
} |
|
4414 |
} else { |
|
4415 |
$args['width'] = $args['size']; |
|
4416 |
} |
|
4417 |
||
4418 |
if ( empty( $args['default'] ) ) { |
|
4419 |
$args['default'] = get_option( 'avatar_default', 'mystery' ); |
|
4420 |
} |
|
4421 |
||
4422 |
switch ( $args['default'] ) { |
|
9 | 4423 |
case 'mm': |
4424 |
case 'mystery': |
|
4425 |
case 'mysteryman': |
|
5 | 4426 |
$args['default'] = 'mm'; |
4427 |
break; |
|
9 | 4428 |
case 'gravatar_default': |
5 | 4429 |
$args['default'] = false; |
4430 |
break; |
|
4431 |
} |
|
4432 |
||
4433 |
$args['force_default'] = (bool) $args['force_default']; |
|
4434 |
||
4435 |
$args['rating'] = strtolower( $args['rating'] ); |
|
4436 |
||
4437 |
$args['found_avatar'] = false; |
|
4438 |
||
4439 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4440 |
* Filters whether to retrieve the avatar URL early. |
5 | 4441 |
* |
4442 |
* Passing a non-null value in the 'url' member of the return array will |
|
4443 |
* effectively short circuit get_avatar_data(), passing the value through |
|
4444 |
* the {@see 'get_avatar_data'} filter and returning early. |
|
4445 |
* |
|
4446 |
* @since 4.2.0 |
|
4447 |
* |
|
16 | 4448 |
* @param array $args Arguments passed to get_avatar_data(), after processing. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4449 |
* @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, |
16 | 4450 |
* user email, WP_User object, WP_Post object, or WP_Comment object. |
5 | 4451 |
*/ |
4452 |
$args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email ); |
|
4453 |
||
9 | 4454 |
if ( isset( $args['url'] ) ) { |
5 | 4455 |
/** This filter is documented in wp-includes/link-template.php */ |
4456 |
return apply_filters( 'get_avatar_data', $args, $id_or_email ); |
|
4457 |
} |
|
4458 |
||
4459 |
$email_hash = ''; |
|
16 | 4460 |
$user = false; |
4461 |
$email = false; |
|
5 | 4462 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4463 |
if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4464 |
$id_or_email = get_comment( $id_or_email ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4465 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4466 |
|
5 | 4467 |
// Process the user identifier. |
4468 |
if ( is_numeric( $id_or_email ) ) { |
|
4469 |
$user = get_user_by( 'id', absint( $id_or_email ) ); |
|
4470 |
} elseif ( is_string( $id_or_email ) ) { |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4471 |
if ( str_contains( $id_or_email, '@md5.gravatar.com' ) ) { |
16 | 4472 |
// MD5 hash. |
5 | 4473 |
list( $email_hash ) = explode( '@', $id_or_email ); |
4474 |
} else { |
|
16 | 4475 |
// Email address. |
5 | 4476 |
$email = $id_or_email; |
4477 |
} |
|
4478 |
} elseif ( $id_or_email instanceof WP_User ) { |
|
16 | 4479 |
// User object. |
5 | 4480 |
$user = $id_or_email; |
4481 |
} elseif ( $id_or_email instanceof WP_Post ) { |
|
16 | 4482 |
// Post object. |
5 | 4483 |
$user = get_user_by( 'id', (int) $id_or_email->post_author ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4484 |
} elseif ( $id_or_email instanceof WP_Comment ) { |
9 | 4485 |
if ( ! is_avatar_comment_type( get_comment_type( $id_or_email ) ) ) { |
5 | 4486 |
$args['url'] = false; |
4487 |
/** This filter is documented in wp-includes/link-template.php */ |
|
4488 |
return apply_filters( 'get_avatar_data', $args, $id_or_email ); |
|
4489 |
} |
|
4490 |
||
4491 |
if ( ! empty( $id_or_email->user_id ) ) { |
|
4492 |
$user = get_user_by( 'id', (int) $id_or_email->user_id ); |
|
4493 |
} |
|
4494 |
if ( ( ! $user || is_wp_error( $user ) ) && ! empty( $id_or_email->comment_author_email ) ) { |
|
4495 |
$email = $id_or_email->comment_author_email; |
|
4496 |
} |
|
4497 |
} |
|
4498 |
||
4499 |
if ( ! $email_hash ) { |
|
4500 |
if ( $user ) { |
|
4501 |
$email = $user->user_email; |
|
4502 |
} |
|
4503 |
||
4504 |
if ( $email ) { |
|
4505 |
$email_hash = md5( strtolower( trim( $email ) ) ); |
|
4506 |
} |
|
4507 |
} |
|
4508 |
||
4509 |
if ( $email_hash ) { |
|
4510 |
$args['found_avatar'] = true; |
|
9 | 4511 |
$gravatar_server = hexdec( $email_hash[0] ) % 3; |
5 | 4512 |
} else { |
4513 |
$gravatar_server = rand( 0, 2 ); |
|
4514 |
} |
|
4515 |
||
4516 |
$url_args = array( |
|
4517 |
's' => $args['size'], |
|
4518 |
'd' => $args['default'], |
|
4519 |
'f' => $args['force_default'] ? 'y' : false, |
|
4520 |
'r' => $args['rating'], |
|
4521 |
); |
|
4522 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4523 |
if ( is_ssl() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4524 |
$url = 'https://secure.gravatar.com/avatar/' . $email_hash; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4525 |
} else { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4526 |
$url = sprintf( 'http://%d.gravatar.com/avatar/%s', $gravatar_server, $email_hash ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4527 |
} |
5 | 4528 |
|
4529 |
$url = add_query_arg( |
|
4530 |
rawurlencode_deep( array_filter( $url_args ) ), |
|
4531 |
set_url_scheme( $url, $args['scheme'] ) |
|
4532 |
); |
|
4533 |
||
4534 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4535 |
* Filters the avatar URL. |
5 | 4536 |
* |
4537 |
* @since 4.2.0 |
|
4538 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4539 |
* @param string $url The URL of the avatar. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4540 |
* @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4541 |
* user email, WP_User object, WP_Post object, or WP_Comment object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4542 |
* @param array $args Arguments passed to get_avatar_data(), after processing. |
5 | 4543 |
*/ |
4544 |
$args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args ); |
|
4545 |
||
4546 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4547 |
* Filters the avatar data. |
5 | 4548 |
* |
4549 |
* @since 4.2.0 |
|
4550 |
* |
|
16 | 4551 |
* @param array $args Arguments passed to get_avatar_data(), after processing. |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4552 |
* @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, |
16 | 4553 |
* user email, WP_User object, WP_Post object, or WP_Comment object. |
5 | 4554 |
*/ |
4555 |
return apply_filters( 'get_avatar_data', $args, $id_or_email ); |
|
4556 |
} |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4557 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4558 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4559 |
* Retrieves the URL of a file in the theme. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4560 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4561 |
* Searches in the stylesheet directory before the template directory so themes |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4562 |
* which inherit from a parent theme can just override one file. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4563 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4564 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4565 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4566 |
* @param string $file Optional. File to search for in the stylesheet directory. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4567 |
* @return string The URL of the file. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4568 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4569 |
function get_theme_file_uri( $file = '' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4570 |
$file = ltrim( $file, '/' ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4571 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4572 |
$stylesheet_directory = get_stylesheet_directory(); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4573 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4574 |
if ( empty( $file ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4575 |
$url = get_stylesheet_directory_uri(); |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4576 |
} elseif ( get_template_directory() !== $stylesheet_directory && file_exists( $stylesheet_directory . '/' . $file ) ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4577 |
$url = get_stylesheet_directory_uri() . '/' . $file; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4578 |
} else { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4579 |
$url = get_template_directory_uri() . '/' . $file; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4580 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4581 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4582 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4583 |
* Filters the URL to a file in the theme. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4584 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4585 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4586 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4587 |
* @param string $url The file URL. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4588 |
* @param string $file The requested file to search for. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4589 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4590 |
return apply_filters( 'theme_file_uri', $url, $file ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4591 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4592 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4593 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4594 |
* Retrieves the URL of a file in the parent theme. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4595 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4596 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4597 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4598 |
* @param string $file Optional. File to return the URL for in the template directory. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4599 |
* @return string The URL of the file. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4600 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4601 |
function get_parent_theme_file_uri( $file = '' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4602 |
$file = ltrim( $file, '/' ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4603 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4604 |
if ( empty( $file ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4605 |
$url = get_template_directory_uri(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4606 |
} else { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4607 |
$url = get_template_directory_uri() . '/' . $file; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4608 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4609 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4610 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4611 |
* Filters the URL to a file in the parent theme. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4612 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4613 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4614 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4615 |
* @param string $url The file URL. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4616 |
* @param string $file The requested file to search for. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4617 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4618 |
return apply_filters( 'parent_theme_file_uri', $url, $file ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4619 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4620 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4621 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4622 |
* Retrieves the path of a file in the theme. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4623 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4624 |
* Searches in the stylesheet directory before the template directory so themes |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4625 |
* which inherit from a parent theme can just override one file. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4626 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4627 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4628 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4629 |
* @param string $file Optional. File to search for in the stylesheet directory. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4630 |
* @return string The path of the file. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4631 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4632 |
function get_theme_file_path( $file = '' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4633 |
$file = ltrim( $file, '/' ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4634 |
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4635 |
$stylesheet_directory = get_stylesheet_directory(); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4636 |
$template_directory = get_template_directory(); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4637 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4638 |
if ( empty( $file ) ) { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4639 |
$path = $stylesheet_directory; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4640 |
} elseif ( $stylesheet_directory !== $template_directory && file_exists( $stylesheet_directory . '/' . $file ) ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4641 |
$path = $stylesheet_directory . '/' . $file; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4642 |
} else { |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4643 |
$path = $template_directory . '/' . $file; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4644 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4645 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4646 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4647 |
* Filters the path to a file in the theme. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4648 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4649 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4650 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4651 |
* @param string $path The file path. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4652 |
* @param string $file The requested file to search for. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4653 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4654 |
return apply_filters( 'theme_file_path', $path, $file ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4655 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4656 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4657 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4658 |
* Retrieves the path of a file in the parent theme. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4659 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4660 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4661 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4662 |
* @param string $file Optional. File to return the path for in the template directory. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4663 |
* @return string The path of the file. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4664 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4665 |
function get_parent_theme_file_path( $file = '' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4666 |
$file = ltrim( $file, '/' ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4667 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4668 |
if ( empty( $file ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4669 |
$path = get_template_directory(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4670 |
} else { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4671 |
$path = get_template_directory() . '/' . $file; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4672 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4673 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4674 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4675 |
* Filters the path to a file in the parent theme. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4676 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4677 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4678 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4679 |
* @param string $path The file path. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4680 |
* @param string $file The requested file to search for. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4681 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4682 |
return apply_filters( 'parent_theme_file_path', $path, $file ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4683 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4684 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4685 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4686 |
* Retrieves the URL to the privacy policy page. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4687 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4688 |
* @since 4.9.6 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4689 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4690 |
* @return string The URL to the privacy policy page. Empty string if it doesn't exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4691 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4692 |
function get_privacy_policy_url() { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4693 |
$url = ''; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4694 |
$policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4695 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4696 |
if ( ! empty( $policy_page_id ) && get_post_status( $policy_page_id ) === 'publish' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4697 |
$url = (string) get_permalink( $policy_page_id ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4698 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4699 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4700 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4701 |
* Filters the URL of the privacy policy page. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4702 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4703 |
* @since 4.9.6 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4704 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4705 |
* @param string $url The URL to the privacy policy page. Empty string |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4706 |
* if it doesn't exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4707 |
* @param int $policy_page_id The ID of privacy policy page. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4708 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4709 |
return apply_filters( 'privacy_policy_url', $url, $policy_page_id ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4710 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4711 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4712 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4713 |
* Displays the privacy policy link with formatting, when applicable. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4714 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4715 |
* @since 4.9.6 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4716 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4717 |
* @param string $before Optional. Display before privacy policy link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4718 |
* @param string $after Optional. Display after privacy policy link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4719 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4720 |
function the_privacy_policy_link( $before = '', $after = '' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4721 |
echo get_the_privacy_policy_link( $before, $after ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4722 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4723 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4724 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4725 |
* Returns the privacy policy link with formatting, when applicable. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4726 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4727 |
* @since 4.9.6 |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4728 |
* @since 6.2.0 Added 'privacy-policy' rel attribute. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4729 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4730 |
* @param string $before Optional. Display before privacy policy link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4731 |
* @param string $after Optional. Display after privacy policy link. Default empty. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4732 |
* @return string Markup for the link and surrounding elements. Empty string if it |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4733 |
* doesn't exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4734 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4735 |
function get_the_privacy_policy_link( $before = '', $after = '' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4736 |
$link = ''; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4737 |
$privacy_policy_url = get_privacy_policy_url(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4738 |
$policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4739 |
$page_title = ( $policy_page_id ) ? get_the_title( $policy_page_id ) : ''; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4740 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4741 |
if ( $privacy_policy_url && $page_title ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4742 |
$link = sprintf( |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4743 |
'<a class="privacy-policy-link" href="%s" rel="privacy-policy">%s</a>', |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4744 |
esc_url( $privacy_policy_url ), |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4745 |
esc_html( $page_title ) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4746 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4747 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4748 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4749 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4750 |
* Filters the privacy policy link. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4751 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4752 |
* @since 4.9.6 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4753 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4754 |
* @param string $link The privacy policy link. Empty string if it |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4755 |
* doesn't exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4756 |
* @param string $privacy_policy_url The URL of the privacy policy. Empty string |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4757 |
* if it doesn't exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4758 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4759 |
$link = apply_filters( 'the_privacy_policy_link', $link, $privacy_policy_url ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4760 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4761 |
if ( $link ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4762 |
return $before . $link . $after; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4763 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4764 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4765 |
return ''; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
4766 |
} |
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4767 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4768 |
/** |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4769 |
* Returns an array of URL hosts which are considered to be internal hosts. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4770 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4771 |
* By default the list of internal hosts is comprised of the host name of |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4772 |
* the site's home_url() (as parsed by wp_parse_url()). |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4773 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4774 |
* This list is used when determining if a specified URL is a link to a page on |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4775 |
* the site itself or a link offsite (to an external host). This is used, for |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4776 |
* example, when determining if the "nofollow" attribute should be applied to a |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4777 |
* link. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4778 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4779 |
* @see wp_is_internal_link |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4780 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4781 |
* @since 6.2.0 |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4782 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4783 |
* @return string[] An array of URL hosts. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4784 |
*/ |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4785 |
function wp_internal_hosts() { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4786 |
static $internal_hosts; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4787 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4788 |
if ( empty( $internal_hosts ) ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4789 |
/** |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4790 |
* Filters the array of URL hosts which are considered internal. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4791 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4792 |
* @since 6.2.0 |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4793 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4794 |
* @param string[] $internal_hosts An array of internal URL hostnames. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4795 |
*/ |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4796 |
$internal_hosts = apply_filters( |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4797 |
'wp_internal_hosts', |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4798 |
array( |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4799 |
wp_parse_url( home_url(), PHP_URL_HOST ), |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4800 |
) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4801 |
); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4802 |
$internal_hosts = array_unique( |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4803 |
array_map( 'strtolower', (array) $internal_hosts ) |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4804 |
); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4805 |
} |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4806 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4807 |
return $internal_hosts; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4808 |
} |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4809 |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4810 |
/** |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4811 |
* Determines whether or not the specified URL is of a host included in the internal hosts list. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4812 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4813 |
* @see wp_internal_hosts() |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4814 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4815 |
* @since 6.2.0 |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4816 |
* |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4817 |
* @param string $link The URL to test. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4818 |
* @return bool Returns true for internal URLs and false for all other URLs. |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4819 |
*/ |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4820 |
function wp_is_internal_link( $link ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4821 |
$link = strtolower( $link ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4822 |
if ( in_array( wp_parse_url( $link, PHP_URL_SCHEME ), wp_allowed_protocols(), true ) ) { |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4823 |
return in_array( wp_parse_url( $link, PHP_URL_HOST ), wp_internal_hosts(), true ); |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4824 |
} |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4825 |
return false; |
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
4826 |
} |