The new musicals have not all done well... most of the big stage hits have already been made into films, you're talking remakes. And they don't bring in as much money as the Marvel Comics made into movies do...
I agree with you. Some musicals have been successful, but definitely not blockbusters. LOL - other than the High School Musical series, I really can't recall a 'hit' musical in the movie theater. Actually, wait, there was Hairspray the remake and Mamma Mia.
I've never seen Mamma Mia on Broadway, but I've watched various pieces of the movie with my nieces. Definitely not the strongest musical cast.
Hairspray was also fun, but I think it got most publicity for John Travolta in drag and Zac Efron.
There was also a 2nd film version of Phantom Of the Opera, but I don't think it was musical. Tom Cruise also recently starred and produced Rock of Ages.
Overall, none were huge hits - they did well enough.
Every now and then the timing, casting and story are 'right' enough to create something iconic - i.e. Grease and Dirty Dancing (technically not a musical)
Les Mis has the music and the cast to be a bigger box office draw than the others. Hugh Jackman is a known triple threat as star of the Boy from Oz on Broadway, multiple box office hits (and some not hits), and host of the Oscars multiple times.