LLMS_Form_Post_Type
LifterLMS Forms Post Type
Description Description
Handle post type registration and interactions
Source Source
File: includes/forms/class-llms-form-post-type.php
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | class LLMS_Form_Post_Type { private $forms = null; /** * User Capability required to manage forms * * @var string */ public $capability = 'manage_lifterlms'; /** * Forms post type name. * * @var string */ public $post_type = 'llms_form'; /** * Constructor * * @since 5.0.0 * * @return void */ public function __construct( $forms ) { $this->forms = $forms; add_action( 'init', array( $this, 'register_post_type' ) ); add_action( 'init', array( $this, 'register_meta' ) ); // Modify permalink. add_filter( 'post_type_link', array( $this, 'modify_permalink' ), 10, 2 ); // Prevent deletion of core forms. add_filter( 'pre_delete_post', array( $this, 'maybe_prevent_deletion' ), 20, 2 ); add_filter( 'pre_trash_post', array( $this, 'maybe_prevent_deletion' ), 20, 2 ); add_filter( 'rest_prepare_post_type', array( $this, 'enable_post_type_visibility' ), 10, 2 ); /** * Filters the capability required to manage LifterLMS Forms * * @since 5.0.0 * * @param string $capability The user capability. Default: "manage_lifterlms". */ $this->capability = apply_filters( 'llms_forms_managment_capability', $this->capability ); } /** * Forces the non-visible form post type to be visible when REST requests for the post type info are made via the admin panel * * This enabled the "Preview in new tab" functionality of the block editor to be used to preview LifterLMS form posts. * * @since 5.0.0 * * @param WP_REST_Response $response Response object. * @param WP_Post_Type $post_type Post Type object. * @return WP_REST_Response */ public function enable_post_type_visibility( $response, $post_type ) { if ( is_admin() && $this->post_type === $post_type->name ) { $response->data['viewable'] = true; } return $response; } /** * Retrieve a permalink for a given form post. * * @since 5.0.0 * * @param WP_Post $post Form post object. * @return string|false Permalink to the form or `false` if no permalink exists for the given location. */ private function get_permalink( $post ) { $url = false; $location = get_post_meta( $post->ID, '_llms_form_location', true ); $method = "get_permalink_for_{$location}"; if ( $this->forms->is_location_valid( $location ) && method_exists( $this, $method ) ) { $url = $this->$method(); } /** * Filters the permalink for a LifterLMS form * * @since 5.0.0 * * @param string|false $url The form's URL. * @param string $location The location ID for the form. * @param WP_Post $post The form post object. */ return apply_filters( 'llms_form_permalink', $url, $location, $post ); } /** * Retrieve permalink for the account edit form * * @since 5.0.0 * * @return string */ private function get_permalink_for_account() { return llms_get_endpoint_url( 'edit-account', '', llms_get_page_url( 'myaccount' ) ); } /** * Retrieve permalink for the checkout form * * @since 5.0.0 * * @return string */ private function get_permalink_for_checkout() { $url = llms_get_page_url( 'checkout' ); $args = array(); // Add an access plan to the URL. $plans = new WP_Query( array( 'post_type' => 'llms_access_plan', 'posts_per_page' => 1, 'orderby' => 'ID', 'order' => 'ASC', ) ); if ( $plans->have_posts() ) { $args = array( 'plan' => $plans->posts[0]->ID, ); } return LLMS_View_Manager::get_url( 'visitor', $url, $args ); } /** * Retrieve permalink for the registration form * * @since 5.0.0 * * @return string|false Permalink or `false` when open registration is disabled. */ private function get_permalink_for_registration() { return LLMS_View_Manager::get_url( 'visitor', llms_get_page_url( 'myaccount' ) ); } /** * Maybe prevent a post from being deleted/trashed. * * We do not allow the "core" forms to be deleted. This action prevents both * deletion and trash actions when run against one of the core form. * * @since 5.0.0 * @since 6.4.0 Use `LLMS_Forms::is_a_core_form()` to determine whether a form is a core form and cannot be deleted. * * @param null|bool $prevent Whether or not the action has been prevented. * @param WP_Post $post The form post object. * @return null|false Returns `null` when we don't prevent the action and `false` if we should. */ public function maybe_prevent_deletion( $prevent, $post ) { if ( $post->post_type === $this->post_type && LLMS_Forms::instance()->is_a_core_form( $post ) ) { $prevent = false; } return $prevent; } /** * Modify the permalink of a given form. * * @since 5.0.0 * * @param string $permalink Default permalink. * @param WP_Post $post Post object. * @return string|false */ public function modify_permalink( $permalink, $post ) { if ( $this->post_type !== $post->post_type ) { return $permalink; } return $this->get_permalink( $post ); } /** * Register the forms post type. * * @since 5.0.0 * * @return void */ public function register_post_type() { $args = array( 'label' => __( 'LifterLMS Forms', 'lifterlms' ), 'labels' => array( 'name' => __( 'Forms', 'lifterlms' ), 'singular_name' => __( 'Form', 'lifterlms' ), 'menu_name' => _x( 'Forms', 'Admin menu name', 'lifterlms' ), 'add_new' => __( 'Add New Form', 'lifterlms' ), 'add_new_item' => __( 'Add New Form', 'lifterlms' ), 'edit' => __( 'Edit', 'lifterlms' ), 'edit_item' => __( 'Edit Form', 'lifterlms' ), 'view' => __( 'View Form', 'lifterlms' ), 'view_item' => __( 'View Form', 'lifterlms' ), 'search_items' => __( 'Search Forms', 'lifterlms' ), 'not_found' => __( 'No Forms found', 'lifterlms' ), 'not_found_in_trash' => __( 'No Forms found in trash', 'lifterlms' ), ), 'public' => false, 'exclude_from_search' => true, 'publicly_queryable' => false, 'show_ui' => true, 'show_in_nav_menus' => false, 'show_in_menu' => 'lifterlms', 'show_in_admin_bar' => false, 'supports' => array( 'title', 'editor', 'custom-fields' ), 'show_in_rest' => true, 'rewrite' => false, 'capabilities' => array( 'edit_post' => $this->capability, 'read_post' => $this->capability, 'delete_post' => $this->capability, 'edit_posts' => $this->capability, 'edit_others_posts' => $this->capability, 'publish_posts' => $this->capability, 'read_private_posts' => $this->capability, 'read' => 'read', 'delete_posts' => $this->capability, 'delete_private_posts' => $this->capability, 'delete_published_posts' => $this->capability, 'delete_others_posts' => $this->capability, 'edit_private_posts' => $this->capability, 'edit_published_posts' => $this->capability, 'create_posts' => false, ), ); LLMS_Post_Types::register_post_type( $this->post_type, $args ); } /** * Register custom postmeta properties for the forms post type. * * @since 5.0.0 * @since 5.10.0 Added new meta for checkout forms and free access plans. * * @return void */ public function register_meta() { $props = array( '_llms_form_location' => array( 'description' => __( 'Determines the front-end location where the form is displayed.', 'lifterlms' ), ), '_llms_form_show_title' => array( 'description' => __( 'Determines whether or not to display the form\'s title on the front-end.', 'lifterlms' ), ), // This is only actually used for 'checkout' forms. '_llms_form_title_free_access_plans' => array( 'description' => __( 'The alternative form title to be shown on checkout for free access plans.', 'lifterlms' ), 'default' => __( 'Student Information', 'lifterlms' ), ), '_llms_form_is_core' => array( 'description' => __( 'Determines if the form is a core form required for basic site functionality.', 'lifterlms' ), ), ); foreach ( $props as $prop => $settings ) { register_meta( 'post', $prop, wp_parse_args( $settings, array( 'object_subtype' => $this->post_type, 'sanitize_callback' => 'sanitize_text_field', 'auth_callback' => array( $this, 'meta_auth_callback' ), 'type' => 'string', 'single' => true, 'show_in_rest' => true, ) ) ); } } /** * Meta field update authorization callback. * * @since 5.0.0 * * @param bool $allowed Is the update allowed. * @param string $meta_key Meta keyname. * @param int $object_id WP Object ID (post,comment,etc)... * @param int $user_id WP User ID. * @param string $cap Requested capability. * @param array $caps User capabilities. * @return bool */ public function meta_auth_callback( $allowed, $meta_key, $object_id, $user_id, $cap, $caps ) { return user_can( $user_id, $this->capability, $object_id ); }} |
Expand full source code Collapse full source code View on GitHub
Methods Methods
- __construct — Constructor
- enable_post_type_visibility — Forces the non-visible form post type to be visible when REST requests for the post type info are made via the admin panel
- get_permalink — Retrieve a permalink for a given form post.
- get_permalink_for_account — Retrieve permalink for the account edit form
- get_permalink_for_checkout — Retrieve permalink for the checkout form
- get_permalink_for_registration — Retrieve permalink for the registration form
- maybe_prevent_deletion — Maybe prevent a post from being deleted/trashed.
- meta_auth_callback — Meta field update authorization callback.
- modify_permalink — Modify the permalink of a given form.
- register_meta — Register custom postmeta properties for the forms post type.
- register_post_type — Register the forms post type.
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |